ONonetrust
Organizations

Update Organization

Changed on

Use this API to update the details of an existing organization within the organizational hierarchy.

put/api/access/v1/external/organizations/{externalId}

Request

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

Path parameters

externalIdstring required

The external identifier of the organization.

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

No Content

Changes

  • df80c4b8e947Revision changes
    • info

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

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional