Lists all members (which can be a User or a Group) of a given Group.
This is a paged endpoint. Each page may be smaller or larger than the requested page size. However,
it is guaranteed that if there are more results available, the nextPageToken field will be populated.
To get the next page, make the same request again, but set the value of the pageToken query parameter
to be value of the nextPageToken value of the previous response. If there is no nextPageToken field
in the response, you are on the last page.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.
booleanWhen true, includes the transitive members of groups contained within this group. For example, say the
Group has member Group A, and Group A has member User B. If transitive=false only Group A will
be returned, but if transitive=true then Group A and User B will be returned. This
will recursively resolve Groups through all layers of nesting.
Defaults to false.
integerThe page size to use for the endpoint.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
objectlist<GroupMember>stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/groupMembers"1
2
3
4
5
6
7
8
9
{
"data": [
{
"principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"principalType": "USER"
}
],
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}| Error Name | ||
|---|---|---|
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The provided page size was zero or negative. Page sizes must be greater than zero. | |
| Parameters | pageSize | |
Group | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Group could not be found. | |
| Parameters | groupId | |
See Errors for a general overview of errors in the platform.