Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Users

Retrieve embed user

Retrieve an embed user using their unique ID. Use the Retrieve user endpoint to retrieve standard users.

get/scim/v2/embed/users/{userId}

Path parameters

userIdstring required

The ID of the embed user to be retrieved

Response

Embed 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

embedEmailstring nullable

The embed user's email address

embedEntitystring

The embed entity identifier

embedExternalIdstring

The external ID for the embed user

Example response

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