Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Users

Retrieve user

Retrieve a user using their unique ID.

get/scim/v2/users/{userId}

Path parameters

userIdstring required

The ID of the user to be retrieved

Response

User details

idstring

Unique identifier for the user

userNamestring

The user's email address

displayNamestring

The user's display name

activeboolean

Whether the user is active

schemasstring[]

SCIM information about the type of schemas used in the API. For example, urn:ietf:params:scim:schemas:core:2.0:User

urn:omni:params:1.0:UserAttributeobject

User attributes as key/value pairs, where keys map to the IDs of user attributes defined in Omni. This is the Reference column in the User attributes page.

Example response

{
  "meta": {
    "resourceType": "User"
  }
}