ONonetrust
Users V2

Create User

Changed on

Use this API to create a new user in your account.

post/api/access/v2/users

Request

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

Request body

firstNamestring required

The first name of the user.

lastNamestring required

The last name of the user.

emailstring email required

The email address of the user.

internalboolean

Indicates whether the user is an internal user.

expirationDateTimestring date-time

The expiration date for the user in the system.

externalIdstring

The external identifier for the user.

suppressNotificationboolean

The indicator to suppress notifying the user on creation.

Example request

{
  "firstName": "Michael",
  "lastName": "Douglas",
  "email": "abc@abc.com",
  "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
    }
  ],
  "suppressNotification": true
}

Response

User created successfully

string required

Identifier of the newly created user

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