🚧  API Specification Update in Progress: We're migrating our APIs from Swagger 2.0 to OpenAPI 3.1.0. This upgrade brings improved compatibility, flexibility, and support for modern API standards. For more information, see OneTrust API Migration to OpenAPI 3.1.0.

Update User

Use this API to fully update all attributes for a user. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.

🗒

Things to Know

  • This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see Legacy SCIM User Provisioning.
  • The following user attributes will be updated using this API: givenName, familyName, externalId, active, division, userType, employeeNumber, department, manager, and title.
  • Any attributes not included in the request will be replaced with a null value. It is best to first retrieve the latest user record using the Get User API, and then modify that response to use in the request for this API. If you only need to update some but not all attributes, use the Modify User API.
Path Params
uuid
required

ID that uniquely identifies a user. The id can be obtained using the Get List of Users API.

Body Params
boolean

Flag to check if the user is an active user or not.

emails
array of objects
required
emails*
string

External ID of the user.

string

ID of the user.

meta
object
name
object
schemas
array of strings
required
schemas*
string

Name of the user.

string

Type of the user.

Responses

400

Bad Request

Possible Reason

The ID in the path must match the ID in the Request Body.

401

Unauthorized

403

Forbidden

404

Not Found

Possible Reason

User with this ID may not exist in this account.

Language
Credentials
OAuth2
Choose an example:
application/json
*/*