Skip to main content

group_organizations

Gets or lists a group_organizations resource.

Overview​

Namegroup_organizations
TypeResource
Idgitlab.groups.group_organizations

Fields​

The following fields are returned by SELECT queries:

GraphQL response envelope

NameDatatypeDescription
idstringInternal ID of the organization.
namestringName of the organization.
activebooleanState of the organization.
created_atstringTimestamp the organization was created.
default_ratenumberStandard billing rate for the organization.
descriptionstringDescription of or notes for the organization.
updated_atstringTimestamp the organization was last updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectfull_path, hostsearch, sort, stateFind organizations of this group. Generated from the GitLab GraphQL schema field Group.organizations (connection of CustomerRelationsOrganization nodes).

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
full_pathstringFull path of the group, for example gitlab-org
hoststringGitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)
sortstringCriteria to sort organizations by.
statestringState of the organization to search for.

SELECT examples​

Find organizations of this group. Generated from the GitLab GraphQL schema field Group.organizations (connection of CustomerRelationsOrganization nodes).

SELECT
id,
name,
active,
created_at,
default_rate,
description,
updated_at
FROM gitlab.groups.group_organizations
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND search = '{{ search }}'
AND sort = '{{ sort }}'
AND state = '{{ state }}'
;