ONonetrust
Organizations

Get List of Organizations

Changed on

Use this API to retrieve a list of all organizations within the organizational hierarchy.

get/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_READ

Response

OK

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.

childrenobject[]

The list of child organizations in the hierarchy.

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",
  "children": [
    {
      "children": [],
      "defaultApprover": "user2@onetrust.com",
      "defaultLanguageCode": "en",
      "description": "Global Privacy Compliance",
      "externalId": "ext-org-123",
      "name": "DataGuidance",
      "parentExternalId": "ext-org-parent-456"
    }
  ]
}

Changes

  • df80c4b8e947Revision changes
    • info

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