List Groups - BlinkOps Documentation

Retrieve a list of groups.

External DocumentationTo learn more, visit the Google Cloud Identity documentation.

Basic Parameters

Parameter	Description
Parent	The parent resource under which to list all Groups. Must be of the form `identitysources/{identity_source_id}` for external-identity-mapped groups or `customers/{customer_id}` for Google Groups.
Return All Pages	Automatically fetch all resources, page by page.
View	The level of detail to retrieve.

Advanced Parameters

Parameter	Description
Delegated User Override	Perform the action on behalf of another user, overriding the delegated user defined in the connection. If not specified, the delegated user is the one provided in the connection. Has no effect when using an OAuth connection. NOTE: the connection details are not edited by this input.
Page Size	The maximum number of objects to retrieve in a single execution.
Page Token	A page token, received from a previous `List Groups` execution. Provide this to retrieve the subsequent page. When paginating, all other parameters provided must match the execution that provided the page token.

Example Output

{
  "groups": [
    {
      "name": string,
      "groupKey": {
        "id": string,
        "namespace": string
      },
      "additionalGroupKeys": [
        {
          "id": string,
          "namespace": string
        }
      ],
      "parent": string,
      "displayName": string,
      "description": string,
      "createTime": string,
      "updateTime": string,
      "labels": {
        string: string,
        string: string
      },
      "dynamicGroupMetadata": {},
      "posixGroups": [
        {
          "name": string,
          "gid": string,
          "systemId": string
        }
      ]
    }
  ],
  "nextPageToken": string
}