group_organizations
Gets or lists a group_organizations resource.
Overview​
| Name | group_organizations |
| Type | Resource |
| Id | gitlab.groups.group_organizations |
Fields​
The following fields are returned by SELECT queries:
- list
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | Internal ID of the organization. |
name | string | Name of the organization. |
active | boolean | State of the organization. |
created_at | string | Timestamp the organization was created. |
default_rate | number | Standard billing rate for the organization. |
description | string | Description of or notes for the organization. |
updated_at | string | Timestamp the organization was last updated. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | full_path, host | search, sort, state | Find 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.
| Name | Datatype | Description |
|---|---|---|
full_path | string | Full path of the group, for example gitlab-org |
host | string | GitLab 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) |
search | string | Search term used to find organizations with. |
sort | string | Criteria to sort organizations by. |
state | string | State of the organization to search for. |
SELECT examples​
- list
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 }}'
;