OMomniapp
SCIM

Get embed user

Changed on

Get details for a specific embed user.

get/api/scim/v2/embed/Users/{id}

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/scim/v2/embed/Users/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

SCIM user ID

Example:550e8400-e29b-41d4-a716-446655440000

Response

Embed user details

activeboolean required

Whether the user is active

displayNamestring required

Display name

embedEmailstring nullable

Email from the embed SSO request. Present only on /api/scim/v2/embed/Users responses.

embedEntitystring nullable

Embed entity the user belongs to. Present only on /api/scim/v2/embed/Users responses.

embedExternalIdstring nullable

External identifier for the embed user (from your system). Present only on /api/scim/v2/embed/Users responses.

idstring uuid required

SCIM user ID

schemasstring[] required

SCIM schema URIs

userNamestring email required

Username (email)

urn:omni:params:1.0:UserAttributeobject required

User attribute values keyed by attribute name, including system attributes that are set. A multi-value attribute holds an array. Number attributes hold strings, except values stored before they were kept as strings, which can still be JSON numbers.

Changes

  • 93bec1bb9033Revision changes
    • warning

      added the new Admin enum value to the / response property for the response status

    • warning

      added the new External enum value to the / response property for the response status

    • warning

      added the new Member enum value to the / response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with 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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property / to the response with the status

  • bf1a790d5a32Revision changes
    • info

      added the optional property to the response with the status