Search documentation
karat

+

K

User Documentation ↗

Get Users Batch

POST/api/v2/admin/users/getBatch

Execute multiple get requests on User.

The maximum batch size for this endpoint is 500.

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

Request body

body
list<GetUsersBatchRequestElement>
Hide child attributes

Hide child attributes

GetUsersBatchRequestElement
object
Show child attributes

Show child attributes

Response body

GetUsersBatchResponse
object
Hide child attributes

Hide child attributes

data
map<PrincipalId, User>
optional
Show child attributes

Show child attributes

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/users/getBatch" \ -d '[{"userId":"f05f8da4-b84c-4fca-9c77-8af0b13d11de"}]'

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 { "data": { "f05f8da4-b84c-4fca-9c77-8af0b13d11de": { "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" } } }