Skip to main content

Delete organization

The endpoint provides functionality to delete an organization.

HTTP request

DELETE https://$instanceId.id.nevis.cloud/nevis/api/v1/organizations/$organizationId

Parameters

ParameterInTypeRequired / OptionalDescription
instanceIdpathstringrequiredThe ID of your Identity Cloud instance
organizationIdpathstringrequiredThe ID of the organization

Example request

Set the ID of the organization.

organizationId=your-organization-id-123
curl --request DELETE "https://$instanceId.id.nevis.cloud/nevis/api/v1/organizations/$organizationId" \
--header "Authorization: Bearer $accessKey"

HTTP response

On success

HTTP/1.1 204 is returned if the organization is successfully deleted.

On failure

HTTP/1.1 401 is returned if the authorization fails due to an invalid access key.

HTTP/1.1 404 is returned if no organization is found with the given organizationId, with a detailed message.

HTTP/1.1 422 is returned if one or more users assigned to the organization.

HTTP/1.1 500 is returned if an unexpected error occurs.