Organizations

Delete Organization

Changed on

Use this API to delete an existing organization and move its associated objects to a different organization.

delete/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_DELETE

Path parameters

externalIdstring required

The external identifier of the organization.

Query parameters

targetExternalIdstring required

The external identifier of the organization that will receive all objects from the deleted organization.

Response

OK

Changes

    • info

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