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 Users.
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
.
integer
The page size to use for the endpoint.
string
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.
boolean
Enables the use of preview functionality.
object
list<User>
object
string
The ID of a Foundry Group or User.
string
The Foundry username of the User. This is unique within the realm.
string
The given name of the User.
string
The family name (last name) of the User.
string
The email at which to contact a User. Multiple users may have the same email address.
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.
string
The 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.
string
list<AttributeValue>
string
string
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.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/users?pageSize=100&pageToken=v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv&preview=true"
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"
}