ScimUser

Required on create: userName and roles. displayName is strongly recommended — if omitted, the user record will have empty first/last name fields, which is rarely the desired outcome. active is ignored on POST (a create always results in active: true, and a POST on an existing user keeps/reactivates them regardless of the body value). On PUT, active must be sent explicitly: omitting it is treated as false and deactivates the user (on RSC: permanently removes them). A POST /Users without at least one role returns 400 with a message containing the word "role"; the request has no effect and no first-access email is sent.

idstring

externalIdstring

Identifier set by the Identity Provider (e.g. Microsoft Entra ID). Accepted on input (no validation error); not persisted; absent from responses.

userNamestringrequired

Email address of the user

displayNamestring

Full name of the user. Set at creation time; subsequent PUT and PATCH requests do not modify this value (no name fields are submitted to the product on updates). Exception: an update that targets a pre-existing password-login (non-SSO) user on RSC or Digital Assets Management re-creates the account and does apply the request displayName — see Existing password-login users under Users created via this API in the introduction.

activeboolean

roles object[]required

Only value is persisted by this service. display is echoed back from the product's role catalog; type and primary are accepted on input but ignored.

Array [

valuestringrequired

Role ID

displaystring

Role display name (read-only — overwritten on response with the product-side role name for the role ID; role IDs the product no longer recognizes are omitted from write responses)

typestring

Entra ID compatibility field; accepted on input (any value, no validation) and discarded — responses always echo WindowsAzureActiveDirectoryRole.

Example: WindowsAzureActiveDirectoryRole

primaryboolean

Accepted on input (no validation error); not persisted — responses always carry primary: false.

]

schemasstring[]

Example: ["urn:ietf:params:scim:schemas:core:2.0:User"]

name object

User name components. Accepted on input (no validation error); not persisted; absent from responses. Use displayName instead.

givenNamestring

familyNamestring

emails object[]

Email addresses for the user. Accepted on input (no validation error); not persisted; absent from responses. Use userName instead.

Array [

valuestring

Email address

primaryboolean

typestring

]

meta object

QRM user responses carry only resourceType; location is not populated.

resourceTypestring

Example: User

locationstring

ScimUser

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "[email protected]",
  "displayName": "Jane Doe",
  "active": true,
  "roles": [
    {
      "value": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "display": "Admin",
      "type": "WindowsAzureActiveDirectoryRole",
      "primary": false
    }
  ]
}