Retrieve an organization

Retrieve an organization by its ID.

Access control

Requires the caller to be an admin in the organization, or any of its ancestors.

Example: Assume an organization hierarchy like: org-a -> org-b -> org-c. To retrieve org-c, which means calling 'GET /api/v1/orgs/org-c', the caller must be an admin in org-a, org-b or org-c.

Securityorg-oidc-token
Request
path Parameters
org
required
string (OrgId) [ 3 .. 64 ] characters ^([a-z][a-z0-9-]{1,62}[a-z0-9])$

ID of an organization

Example: my-org
Responses
200

An organization

get/api/v1/orgs/{org}
Request samples 
Response samples 
application/json
{
  • "id": "my-org",
  • "parentId": "my-org",
  • "idp": {},
  • "migrationStatus": "EXCLUSIVE_LOGIN",
  • "adminGroupId": "my-external-group",
  • "isDeleted": false,
  • "adminsCanCreateOrgsInSubtree": false,
  • "adminsCanCreateProjectsInSubtree": false,
  • "allowedClusters": [
    • "westeurope-1",
    • "asia-northeast1-1"
    ],
  • "profilesEnabled": true,
  • "contactPersons": [
    • {
      }
    ]
}
➔ Next to Projects