Identity Hub API, REST: Group.ListEffective

Field

Description

subjectId

string

Required field. ID of the subject to list groups for.

organizationId

string

The ID of the organization to scope the group search to.
If omitted and the subject belongs to a single organization,
that organization's ID will be used automatically.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListEffectiveResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Acceptable values are 0 to 1000, inclusive. Default value: 100.

pageToken

string

Page token. Set pageToken
to the ListEffectiveResponse.nextPageToken
returned by a previous list request to get the next page of results.

filter

string

A filter expression that filters resources listed in the response.
The expression supports the following operations:

• = for exact match: name = 'example-name'
• IN for multiple values: id IN ('id1', 'id2')
• contains for domain substring search: name contains 'example'
• AND for combining conditions: name contains 'my-group' AND name contains 'name'

Available fields for filtering:

• id - group ID
• name - group name

Must be 1-1000 characters long.

Field

Description

groupMembershipInfo[]

GroupMembershipInfo

List of group membership information.
Contains groups where the specified subject is a member.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListEffectiveRequest.pageSize, use the nextPageToken as the value
for the ListEffectiveRequest.pageToken query parameter in the next list request.
Each subsequent list request will have its own nextPageToken to continue paging through the results.

Field

Description

groupId

string

ID of the group the subject is a member of.

groupName

string

Name of the group the subject is a member of.