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.
objectobjectstring (enum)Enum values: queryString
stringintegerThe 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 populate the next request's pageToken field with it.
objectlist<User>objectstringThe ID of a Foundry Group or User.
stringThe Foundry username of the User. This is unique within the realm.
stringThe given name of the User.
stringThe family name (last name) of the User.
stringThe email at which to contact a User. Multiple users may have the same email address.
stringIdentifies 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.
stringThe RID of the user's primary Organization. This will be blank for third-party application service users.
map<AttributeName, AttributeValues>A map of the User's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. Additional attributes may be configured by Foundry administrators in Control Panel and populated by the User's SSO provider upon login.
stringlist<AttributeValue>stringstringThe 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.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/users/search?preview=true" \
-d '{"pageSize":100,"where":{"type":"queryString"},"pageToken":"v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv"}'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": [
{
"givenName": "John",
"familyName": "Smith",
"organization": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa",
"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",
"email": "jsmith@example.com",
"username": "jsmith"
}
],
"nextPageToken": "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv"
}