TOtoriihq
SCIM

Update User (PUT)

Update Torii user<p><ul><li>Only active users can be updated.</li><li>The user's <code>userName</code> (email address) cannot be updated.</li><li>To deactivate a user, use <code>active: false</code></li><li>Use the <code>POST</code> method to reactivate inactive users.</li><li>If the user is the last admin in the org, you cannot update his role.</li></p>

<p><ul><li>Rate limit: 200 requests per minute</li></ul></p>
put/scim/v2/Users/{idUser}

Request

  • Base URL
    https://api.toriihq.com/v1.0
  • Auth
    API key in header Authorization

Path parameters

idUserinteger required

Unique user identifier

Request body

schemasModel134[] required

An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

idnumber

The user's ID in Torii

userNamestring required

The user's email address.

userTypestring

The role of the user in Torii. The role will not change if this parameter is not passed.<br>Must be a valid Torii role name or custom role name (e.g. "Admin", "Read Only", etc.)

activeboolean

If <b>active: false</b>, the user will be deactivated.

Example request

{
  "schemas": [
    [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ]
  ],
  "id": 1234,
  "userName": "tony@stark.com",
  "userType": "Admin",
  "active": true
}

Response

SCIM user schema

schemasModel70[] required

An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

idstring

The user's ID in Torii

userNamestring

Must be an email address. Cannot be changed after the user is created.

activeboolean

A Boolean value indicating the User's administrative status.

userTypestring

The role of the user in Torii.

Example response

{
  "schemas": [
    [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ]
  ],
  "id": "1234",
  "userName": "tony@stark.com",
  "name": {
    "familyName": "Stark",
    "givenName": "Tony"
  },
  "active": true,
  "emails": [
    {
      "primary": true,
      "value": "tony@stark.com"
    }
  ],
  "userType": "Admin",
  "meta": {
    "created": "2022-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.