group_organization_state_counts
Gets or lists a group_organization_state_counts resource.
Overview​
| Name | group_organization_state_counts |
| Type | Resource |
| Id | gitlab.groups.group_organization_state_counts |
Fields​
The following fields are returned by SELECT queries:
- get
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
active | integer | Number of organizations with state ACTIVE |
all_ | integer | Number of organizations with state ALL |
inactive | integer | Number of organizations with state INACTIVE |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | full_path, host | search, state | Counts of organizations by status for the group. Generated from the GitLab GraphQL schema field Group.organizationStateCounts (OrganizationStateCounts). |
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 to find organizations with. |
state | string | State of the organizations to search for. |
SELECT examples​
- get
Counts of organizations by status for the group. Generated from the GitLab GraphQL schema field Group.organizationStateCounts (OrganizationStateCounts).
SELECT
active,
all_,
inactive
FROM gitlab.groups.group_organization_state_counts
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND search = '{{ search }}'
AND state = '{{ state }}'
;