Search documentation
karat

+

K

User Documentation ↗

List Group Members

GET/api/v2/admin/groups/{groupId}/groupMembers

Lists all GroupMembers.

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.

Path parameters

groupId
string

The ID of a Foundry Group or User.

Query parameters

transitive
boolean
optional

When 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.

pageSize
integer
optional

The page size to use for the endpoint.

pageToken
string
optional

The 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.

Response body

ListGroupMembersResponse
object
Hide child attributes

Hide child attributes

data
list<GroupMember>
optional
Show child attributes

Show child attributes

GroupMember
object
Show child attributes

Show child attributes

principalType
string (enum)

Enum values: USER, GROUP

principalId
string

The ID of a Foundry Group or User.

nextPageToken
string
optional

The 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.

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/groups/f05f8da4-b84c-4fca-9c77-8af0b13d11de/groupMembers?pageSize=100&pageToken=v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"

Response

Copied!
1 2 3 4 5 6 7 8 9 { "data": [ { "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "principalType": "USER" } ], "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z" }