ONonetrust
Users V2

Update User

Changed on

Use this API to update the details for a single user in your account.

put/api/access/v2/users/{userId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/access/v2/users/{userId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: USER, USER_WRITE

Path parameters

userIdstring uuid required

The unique identifier of the user.

Request body

firstNamestring required

The first name of the user.

lastNamestring required

The last name of the user.

internalboolean

The indicator of whether the user is an internal user.

expirationDateTimestring date-time

User expiration date in the system

externalIdstring

The external identifier for the user.

Example request

{
  "firstName": "Michael",
  "lastName": "Douglas",
  "internal": true,
  "expirationDateTime": "2029-05-01T12:34:56Z",
  "externalId": "1A2234-abc",
  "accessLevels": [
    {
      "organizationId": "323e4567-e89b-12d3-a456-426614174000",
      "roleIds": [
        "550e8400-e29b-41d4-a716-446655440000"
      ],
      "defaultOrganization": true
    }
  ]
}

Response

User updated successfully

Changes

  • df80c4b8e947Revision changes
    • breaking

      the request property became required

    • breaking

      the request property // became required

    • info

      the security scope USER_WRITE was added to the endpoint's security scheme Platform-AccessManagement_OAUTH2