Search documentation
karat

+

K

User Documentation ↗

List Group Memberships

GET/api/v2/admin/users/{userId}/groupMemberships
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Lists all GroupMemberships.

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

userId
string

The ID of a Foundry Group or User.

Query parameters

transitive
boolean
optional

When true, includes the transitive memberships of the Groups the User is a member of. For example, say the User is a member of Group A, and Group A is a member of Group B. If transitive=false only Group A will be returned, but if transitive=true then Groups A and 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 populate the next request's pageToken field with it.

preview
boolean
optional

Enables the use of preview functionality.

Response body

ListGroupMembershipsResponse
object
Hide children

Hide children

data
list<GroupMembership>
optional
Show children

Show children

GroupMembership
object
Show children

Show children

groupId
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 populate the next request's pageToken field with it.

Examples

Request

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

Response

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