Search documentation
karat

+

K

User Documentation ↗

Get User

GET/api/v2/admin/users/{userId}
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.

Get the User with the specified id.

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

preview
boolean
optional

Enables the use of preview functionality.

Response body

User
object
Hide children

Hide children

id
string

The ID of a Foundry Group or User.

username
string

The Foundry username of the User. This is unique within the realm.

givenName
string
optional

The given name of the User.

familyName
string
optional

The family name (last name) of the User.

email
string
optional

The email at which to contact a User. Multiple users may have the same email address.

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.

organization
string
optional

The RID of the user's primary Organization. This will be blank for third-party application service users.

attributes
map<AttributeName, AttributeValues>
optional

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.

Show children

Show children

AttributeName
string
AttributeValues
list<AttributeValue>
Show children

Show children

AttributeValue
string

Examples

Request

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

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 { "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" }