Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Users V2

Create User

Use this API to create a user and associate that user with the configured organization and role. 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.
  • If a value is not provided for roles or organization in the request, the newly created user will be assigned the default role and organization as configured on the User Provisioning screen within Global Settings in the OneTrust application.
  • This API supports assigning the user to multiple roles within one organization. If the user should be assigned to other role-organization combinations (SCIM groups), use the Modify Group Members API.
post/api/scim/v2/Users

Request body

idstring uuid

Unique identifier for the user created by the OneTrust application.

externalIdstring

External Id

schemasstring[]
userNamestring email

Username of the user in the OneTrust application.

userType'Internal' | 'External'

Type of the user.

activeboolean

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

rolesstring[]
titlestring

Job title of the user

Example request

{
  "id": "aeb3d45d-0c05-4ff0-b635-6e3c3b2f86ea",
  "externalId": "3PNdoRZES0GLfV+9y1dDwQ==",
  "meta": {
    "created": "2022-05-27T15:28:14.298Z",
    "lastModified": "2022-05-27T15:28:14.298Z",
    "location": "/api/scim/v3/Users/53b1325c-081f-4f05-b41b-ba8cbdb7bae9",
    "version": "W/\"f0f2a936\"",
    "attributes": [
      [
        "active",
        "emails",
        "userName"
      ]
    ],
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "gpburdell@onetrust.com",
  "name": {
    "familyName": "Smith",
    "givenName": "John"
  },
  "userType": "Internal",
  "active": true,
  "groups": [
    {
      "value": "5175be33-9b8d-4483-9d8b-1a9fb78bd97d",
      "display": "R&D"
    }
  ],
  "emails": [
    {
      "value": "gpburdell@onetrust.com",
      "display": "gpburdell@onetrust.com",
      "primary": true,
      "type": "work"
    }
  ],
  "roles": [
    "[\"Auditor\",\"Business Owner\",\"Employee\",\"Privacy Officer\",\"Site Admin\"]"
  ],
  "title": "Product Manager",
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "businessUnit": "ESG",
    "division": "North America",
    "employeeNumber": "8675309",
    "officeLocation": "New York",
    "department": "R&D",
    "manager": {
      "value": "23498234-9283-4620-8204-652982504620",
      "displayName": "John Doe",
      "$ref": "/api/scim/v3/Users/23498234-9283-4620-8204-652982504620"
    },
    "organization": "OneTrust",
    "legacyManager": "legacy manager"
  }
}

Response

Created

idstring uuid

Unique identifier for the user created by the OneTrust application.

externalIdstring

External Id

schemasstring[]
userNamestring email

Username of the user in the OneTrust application.

userType'Internal' | 'External'

Type of the user.

activeboolean

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

rolesstring[]
titlestring

Job title of the user

Example response

{
  "id": "aeb3d45d-0c05-4ff0-b635-6e3c3b2f86ea",
  "externalId": "3PNdoRZES0GLfV+9y1dDwQ==",
  "meta": {
    "created": "2022-05-27T15:28:14.298Z",
    "lastModified": "2022-05-27T15:28:14.298Z",
    "location": "/api/scim/v3/Users/53b1325c-081f-4f05-b41b-ba8cbdb7bae9",
    "version": "W/\"f0f2a936\"",
    "attributes": [
      [
        "active",
        "emails",
        "userName"
      ]
    ],
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "gpburdell@onetrust.com",
  "name": {
    "familyName": "Smith",
    "givenName": "John"
  },
  "userType": "Internal",
  "active": true,
  "groups": [
    {
      "value": "5175be33-9b8d-4483-9d8b-1a9fb78bd97d",
      "display": "R&D"
    }
  ],
  "emails": [
    {
      "value": "gpburdell@onetrust.com",
      "display": "gpburdell@onetrust.com",
      "primary": true,
      "type": "work"
    }
  ],
  "roles": [
    "[\"Auditor\",\"Business Owner\",\"Employee\",\"Privacy Officer\",\"Site Admin\"]"
  ],
  "title": "Product Manager",
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "businessUnit": "ESG",
    "division": "North America",
    "employeeNumber": "8675309",
    "officeLocation": "New York",
    "department": "R&D",
    "manager": {
      "value": "23498234-9283-4620-8204-652982504620",
      "displayName": "John Doe",
      "$ref": "/api/scim/v3/Users/23498234-9283-4620-8204-652982504620"
    },
    "organization": "OneTrust",
    "legacyManager": "legacy manager"
  }
}