SCIM

Create SCIM user

Changed on
post/api/scim/v2/Users

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/Users
  • Auth
    HTTP bearer

Request body

displayNamestring required

Display name of the user

urn:omni:params:1.0:UserAttributeobject

Omni user attributes

userNamestring email required

Email address (username) of the user

Example request

{
  "displayName": "John Doe",
  "userName": "user@example.com"
}

Response

SCIM user created

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

    • 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

    • info

      added the new optional request property /