Search documentation
karat

+

K

User Documentation ↗

Search Groups

POST/api/v2/admin/groups/search
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.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Request body

SearchGroupsRequest
object
Hide children

Hide children

where
object
Show children

Show children

type
string (enum)

Enum values: queryString

value
string
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.

Response body

SearchGroupsResponse
object
Hide children

Hide children

data
list<Group>
optional
Show children

Show children

Group
object
Show children

Show children

id
string

The ID of a Foundry Group or User.

name
string

The name of the Group.

description
string
optional

A description of the Group.

realm
string

Identifies which Realm a User or Group is a member of. The palantir-internal-realm is used for Users or Groups that are created in Foundry by administrators and not associated with any SSO provider.

organizations
list<OrganizationRid>
optional

The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed.

Show children

Show children

OrganizationRid
string
attributes
map<AttributeName, AttributeValues>
optional

A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.

Show children

Show children

AttributeName
string
AttributeValues
list<AttributeValue>
Show children

Show children

AttributeValue
string
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 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/groups/search?preview=true" \ -d '{"pageSize":100,"where":{"type":"queryString"},"pageToken":"v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv"}'

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "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", "id": "f05f8da4-b84c-4fca-9c77-8af0b13d11de" } ], "nextPageToken": "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv" }