OMomni
Users

Retrieve embed user

Changed on

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

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

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/scim/v2/embed/users/{userId}
  • Auth
    HTTP bearer

Path parameters

userIdstring required

The ID of the embed user to be retrieved

Response

Embed user details

idstring required

Unique identifier for the user

userNamestring required

The user's email address

displayNamestring required

The user's display name

activeboolean required

Whether the user is active

schemasstring[] required

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 required

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. A value is a string, a number, an array of strings or an array of numbers for a multi-value attribute, or null. Numbers appear only for legacy values stored before Omni started saving attribute values as strings.

embedEmailstring nullable

The embed user's email address

embedEntitystring nullable

The embed entity identifier

embedExternalIdstring nullable

The external ID for the embed user

Example response

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

Changes

  • 43290040f88fRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status