List Groups

Retrieves all groups of a domain or of a user given a userKey (paginated).

Basic Parameters

Parameter	Description
Customer ID	The unique ID for the customer's Google Workspace account. You can't use this field together with the user field. As an account administrator, you can also use the 'my_customer' alias to represent your account's customer ID. The customer ID is also returned as part of the ListUsers action.
Query	Query string search. For example: "name=Example". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups
User	An email or an immutable ID of a user to list the groups of. Leave blank to list all groups. You can't use this field together with the customer ID.

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.

Example Output

{
    "etag": "ETag of the resource.",
    "groups": [
        {
            "adminCreated": false,
            "aliases": [
                "string"
            ],
            "description": "An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.",
            "directMembersCount": "The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.",
            "email": "The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.",
            "etag": "ETag of the resource.",
            "id": "The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.",
            "kind": "admin#directory#group",
            "name": "The group's display name.",
            "nonEditableAliases": [
                "string"
            ]
        }
    ],
    "kind": "admin#directory#groups",
    "nextPageToken": "Token used to access next page of this result."
}

Workflow Library Example

Sync Groups Between Google Workspace and Aws Sso

Preview this Workflow on desktop