---
updatedAt: 2026-05-27T12:54:01.000Z
agentTools:
  projectIndex: https://developer.onetrust.com/onetrust/llms.txt
---

# 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](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad).
> - 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](https://developer.onetrust.com/onetrust/reference/getuserbyid) 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](https://developer.onetrust.com/onetrust/reference/modifyuser) API.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Platform - User Provisioning",
    "description": "OneTrust supports cross-domain identity management through the SCIM 2.0 specification. System for Cross-Domain Identity Management (SCIM) is an open specification to help facilitate the automated management of user identities and groups in cloud applications using RESTful APIs. This allows organizations to manage and update user information and group information across domains and applications.",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    }
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Users V3",
      "description": "V3 version APIs to manager Users.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"
      }
    }
  ],
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0",
    "links": [
      "{'SCIM User & Group Provisioning': 'https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad?topicId=0TO1Q000000ItSxWAK'}"
    ]
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "paths": {
    "/api/scim/v3/Users/{id}": {
      "put": {
        "operationId": "updateUser",
        "summary": "Update User",
        "description": "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.\n\n> 🗒 Things to Know\n>\n> - 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](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad).\n> - The response will always return the following values for roles and organization: `\"roles\": []` and `\"organization\": null`.\n> - The following user attributes will be updated using this API: `givenName`, `familyName`, `externalId`, `active`, `division`, `employeeNumber`, `department`, `manager`, and `title`.\n> - 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](https://developer.onetrust.com/onetrust/reference/getuserbyid) 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](https://developer.onetrust.com/onetrust/reference/modifyuser) API.\n",
        "tags": [
          "Users V3"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID that uniquely identifies the SCIM user. The `id` can be obtained using the [Get List of Users](/onetrust/reference/getusers) API.\n",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserResource"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK\n\nUser details modified successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserResource"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "OAUTH2": [
              "SCIM",
              "INTEGRATION",
              "USER"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "UserGroup": {
        "type": "object",
        "properties": {
          "value": {
            "description": "Unique identifier of a group in the application.",
            "type": "string",
            "example": "5175be33-9b8d-4483-9d8b-1a9fb78bd97d"
          },
          "display": {
            "description": "Name of the User Group in the application.",
            "type": "string",
            "example": "R&D"
          }
        },
        "readOnly": true,
        "title": "Group"
      },
      "Email": {
        "type": "object",
        "properties": {
          "value": {
            "description": "Email of the user.",
            "type": "string",
            "format": "email",
            "example": "gpburdell@onetrust.com",
            "minLength": 1
          },
          "display": {
            "description": "Email of the user.",
            "type": "string",
            "format": "email",
            "example": "gpburdell@onetrust.com",
            "readOnly": true
          },
          "primary": {
            "description": "Is the email the user's primary. Always `true` in the OneTrust application.",
            "type": "boolean",
            "example": true,
            "default": "true",
            "readOnly": true
          },
          "$ref": {
            "description": "Reference for the attribute",
            "type": "string",
            "format": "string"
          },
          "type": {
            "description": "The type of the email. In the OneTrust application, type is always 'work'.",
            "type": "string",
            "example": "work",
            "default": "work"
          }
        },
        "required": [
          "value"
        ]
      },
      "AbstractBaseResource": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique identifier for the user created by the OneTrust application.",
            "type": "string",
            "format": "uuid",
            "example": "aeb3d45d-0c05-4ff0-b635-6e3c3b2f86ea",
            "maxLength": 100,
            "readOnly": true
          },
          "externalId": {
            "description": "External Id",
            "type": "string",
            "example": "3PNdoRZES0GLfV+9y1dDwQ==",
            "maxLength": 100
          },
          "meta": {
            "$ref": "#/components/schemas/Meta",
            "readOnly": true
          },
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true,
            "writeOnly": true
          }
        },
        "title": "AbstractBaseResource"
      },
      "EnterpriseUser": {
        "type": "object",
        "properties": {
          "businessUnit": {
            "description": "User's business unit.",
            "type": "string",
            "example": "ESG",
            "maxLength": 255
          },
          "division": {
            "description": "The division with which the user is associated.",
            "type": "string",
            "example": "North America",
            "maxLength": 255
          },
          "employeeNumber": {
            "description": "User's employee number or ID.",
            "type": "string",
            "example": "8675309",
            "maxLength": 255
          },
          "officeLocation": {
            "description": "The office location of the user.",
            "type": "string",
            "example": "New York",
            "maxLength": 255
          },
          "department": {
            "description": "The department with which the user is associated.",
            "type": "string",
            "example": "R&D",
            "maxLength": 255
          },
          "manager": {
            "$ref": "#/components/schemas/Manager"
          },
          "organization": {
            "description": "Organization of the user within the OneTrust application.",
            "type": "string",
            "example": "OneTrust",
            "maxLength": 255
          },
          "legacyManager": {
            "description": "The legacy manager of the user.",
            "type": "string",
            "example": "legacy manager",
            "maxLength": 255
          }
        },
        "title": "Additional Attributes"
      },
      "Manager": {
        "type": "object",
        "properties": {
          "value": {
            "description": "The manager's GUID or `id` in the OneTrust application. Leverage the [Get List of Users](/onetrust/reference/getusers) API to obtain a list of users. Use the manager's `id` to populate `value`.",
            "type": "string",
            "example": "23498234-9283-4620-8204-652982504620",
            "maxLength": 100,
            "minLength": 1
          },
          "displayName": {
            "description": "Manager's full name in the application.",
            "type": "string",
            "example": "John Doe",
            "readOnly": true
          },
          "$ref": {
            "description": "Reference URL to the user",
            "type": "string",
            "format": "url",
            "example": "/api/scim/v3/Users/23498234-9283-4620-8204-652982504620",
            "readOnly": true
          }
        },
        "required": [
          "value"
        ],
        "title": "Manager"
      },
      "Meta": {
        "type": "object",
        "properties": {
          "created": {
            "description": "The date and time when the resource was created",
            "type": "string",
            "format": "date-time",
            "example": "2022-05-27T15:28:14.298Z"
          },
          "lastModified": {
            "description": "The date and time when the resource was last modified",
            "type": "string",
            "format": "date-time",
            "example": "2022-05-27T15:28:14.298Z"
          },
          "location": {
            "description": "The URL for the resource",
            "type": "string",
            "format": "uri",
            "example": "/api/scim/v3/Users/53b1325c-081f-4f05-b41b-ba8cbdb7bae9",
            "maxLength": 2083,
            "minLength": 1
          },
          "version": {
            "description": "The version of the resource",
            "type": "string",
            "example": "W/\"f0f2a936\"",
            "maxLength": 100,
            "minLength": 1
          },
          "attributes": {
            "type": "array",
            "items": {
              "description": "The set of attributes",
              "example": [
                "active",
                "emails",
                "userName"
              ]
            },
            "uniqueItems": true
          },
          "resourceType": {
            "description": "The resource type",
            "type": "string",
            "example": "Group",
            "enum": [
              "User",
              "Group",
              "ResourceType",
              "ServiceProviderConfig",
              "Schema"
            ],
            "maxLength": 100,
            "minLength": 1
          }
        },
        "readOnly": true,
        "title": "Meta"
      },
      "Name": {
        "type": "object",
        "properties": {
          "familyName": {
            "description": "Family name (last name) of the user.",
            "type": "string",
            "example": "Smith",
            "maxLength": 100,
            "minLength": 1
          },
          "givenName": {
            "description": "Given name (first name) of the user.",
            "type": "string",
            "example": "John",
            "maxLength": 100,
            "minLength": 1
          }
        },
        "title": "Name"
      },
      "UserResource": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/AbstractBaseResource"
          },
          {
            "type": "object",
            "properties": {
              "schemas": {
                "type": "array",
                "items": {
                  "description": "A collection of attribute definitions that describe the contents of an entire or partial resource.",
                  "enum": [
                    "urn:ietf:params:scim:schemas:core:2.0:User"
                  ],
                  "example": "urn:ietf:params:scim:schemas:core:2.0:User"
                },
                "uniqueItems": true
              },
              "userName": {
                "description": "Username of the user in the OneTrust application.",
                "type": "string",
                "format": "email",
                "example": "gpburdell@onetrust.com",
                "maxLength": 256
              },
              "name": {
                "$ref": "#/components/schemas/Name"
              },
              "userType": {
                "description": "Type of the user.",
                "type": "string",
                "example": "Internal",
                "enum": [
                  "Internal",
                  "External"
                ]
              },
              "active": {
                "description": "The flag to check whether the user is an active or an inactive user.",
                "type": "boolean",
                "example": true
              },
              "groups": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/UserGroup",
                  "readOnly": true
                },
                "readOnly": true
              },
              "emails": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Email"
                }
              },
              "roles": {
                "type": "array",
                "items": {
                  "format": "json",
                  "description": "Role of the user within the OneTrust application.",
                  "examples": [
                    "[\"Auditor\",\"Business Owner\",\"Employee\",\"Privacy Officer\",\"Site Admin\"]"
                  ]
                }
              },
              "title": {
                "description": "Job title of the user",
                "type": "string",
                "example": "Product Manager",
                "maxLength": 255
              },
              "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
                "description": "Enterprise user details",
                "$ref": "#/components/schemas/EnterpriseUser"
              }
            }
          }
        ],
        "required": [
          "name"
        ],
        "title": "UserResource"
      }
    },
    "securitySchemes": {
      "OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "SCIM": "Grants full access to the SCIM APIs for User Provisioning. This includes all the endpoints under Users, Groups, Resources, Schemas and Service Provider."
            }
          }
        }
      }
    }
  }
}
```

# Sibling pages

* [Get List of Users](https://developer.onetrust.com/onetrust/reference/getusers.md)
* [Create User](https://developer.onetrust.com/onetrust/reference/createuser.md)
* [Get User](https://developer.onetrust.com/onetrust/reference/getuserbyid.md)
* [Modify User](https://developer.onetrust.com/onetrust/reference/modifyuser.md)