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 Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see SCIM User & Group Provisioning.
  • The response will always return the following values for roles and organization: "roles": [] and "organization": null.
  • The following user attributes will be updated using this API: givenName, familyName, externalId, active, division, 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 the SCIM user. The id can be obtained using the Get List of Users API.

Body Params
string
length ≤ 100

External Id

schemas
array of strings
string
length ≤ 256

Username of the user in the OneTrust application.

name
object
required
string
enum

Type of the user.

Allowed:
boolean

The flag to check whether the user is an active or an inactive user.

emails
array of objects
emails
roles
array
roles
string
length ≤ 255

Job title of the user

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
object

Enterprise user details

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 3 required scopes
URL
LoadingLoading…
Response
Choose an example:
application/json
*/*