Sign in
Organization

Get an organization

Get the details of an organization.

Permissions

This endpoint may be impacted by the following permissions:

  • The default_user_preferences field is only populated if the endpoint is called with user authentication credentials, and the authenticated user has the Organization:GetOrganizationDetails permission.
get/v1/{organization}/organization/

Path parameters

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

org_idstring required

Unique identifier of the organization.

org_namestring required

A human friendly name of the organization.

tenant_idstring nullable required

The tenant ID of the organization. This field is only populated if the authenticated user has the Organization:GetOrganizationDetails permission.

Changes

No recorded changes to this endpoint across all 16 revisions of this API.