Search documentation
karat

+

K

User Documentation ↗

List Groups

GET/api/v2/admin/groups

Lists all Groups.

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.

Query parameters

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

ListGroupsResponse
object
Hide child attributes

Hide child attributes

data
list<Group>
optional
Show child attributes

Show child attributes

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?pageSize=100&pageToken=v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 { "data": [ { "name": "Data Source Admins", "organizations": [ "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa" ], "description": "Create and modify data sources in the platform", "realm": "palantir-internal-realm", "attributes": { "multipass:givenName": [ "John" ], "multipass:familyName": [ "Smith" ], "multipass:email:primary": [ "jsmith@example.com" ], "multipass:realm": [ "eab0a251-ca1a-4a84-a482-200edfb8026f" ], "multipass:organization-rid": [ "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa" ], "department": [ "Finance" ], "jobTitle": [ "Accountant" ] }, "id": "f05f8da4-b84c-4fca-9c77-8af0b13d11de" } ], "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z" }