ONonetrust
Organizations

Create Organization

Changed on

Use this API to create an organization within the organizational hierarchy.

🗒 Things to Know

  • The organization will be created as a child of the organization specified in the parentExternalId parameter. If a parentExternalIdvalue is not specified in the request, the organization will be created as a child of the root organization.
post/api/access/v1/external/organizations

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/access/v1/external/organizations
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ORGANIZATION, ORGANIZATION_WRITE

Request body

externalIdstring

The external identifier of the organization. Accepts alphanumeric characters, underscores, periods, colons, and hyphens.

parentExternalIdstring

The external identifier of the parent organization.

parentOrganizationIdstring uuid

The unique identifier of the parent organization.

defaultLanguageCodestring

The ISO language code for the organization's default language (for example: en, fr, de, es, zh).

namestring

The name of the organization.

defaultApproverstring email

The email address of the default approver for the organization.

descriptionstring

A brief description of the organization.

Example request

{
  "externalId": "ext-org-123",
  "parentExternalId": "ext-org-parent-456",
  "parentOrganizationId": "123e4567-e89b-12d3-a456-426614174002",
  "defaultLanguageCode": "en",
  "name": "OneTrust",
  "defaultApprover": "approver@onetrust.com",
  "description": "Privacy, Security and Third-Party Risk Software"
}

Response

Created

organizationIdstring uuid

The unique identifier of the organization.

externalIdstring

The external identifier of the organization.

parentOrganizationIdstring uuid

The unique identifier of the parent organization.

parentExternalIdstring

The external identifier of the parent organization.

namestring

The name of the organization.

defaultApproverstring

The email address of the default approver for the organization.

defaultLanguageCodestring

The ISO language code for the organization's default language (for example: en, fr, de, es, zh).

descriptionstring

A brief description of the organization.

Example response

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "ext-org-123",
  "parentOrganizationId": "123e4567-e89b-12d3-a456-426614174999",
  "parentExternalId": "ext-org-parent-456",
  "name": "OneTrust",
  "defaultApprover": "approver@onetrust.com",
  "defaultLanguageCode": "en",
  "description": "Privacy, Security and Third-Party Risk Software"
}

Changes

  • df80c4b8e947Revision changes
    • info

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