TOtoriihq
Users

Update user

Updates the user with fields sent in the request body. Setting lifecycleStatus to offboarded for a user whose offboarding is in progress marks their remaining apps as done and completes their open offboarding tasks.

<p><ul><li>Rate limit: 200 requests per minute</li></ul></p>
put/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

lifecycleStatus'active' | 'offboarding' | 'offboarded' required

Lifecycle status

Example request

{
  "lifecycleStatus": "active"
}

Response

User

Example response

{
  "user": {
    "id": 1000,
    "idOrg": 1000,
    "firstName": "Tony",
    "lastName": "Tony",
    "email": "tony@stark.com",
    "creationTime": "2020-01-01T00:00:00.000Z",
    "idRole": 1,
    "role": "Admin",
    "lifecycleStatus": "active",
    "isDeletedInIdentitySources": true,
    "isExternal": true,
    "activeAppsCount": 1,
    "additionalEmails": [
      "tony@stark.com"
    ]
  }
}

Changes

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