Retrieve an organization

{ "id": "my-org", "parentId": "my-org", "idp": { "issuer": "https://login.microsoftonline.com/some-tenant-id/v2.0" }, "adminsCanCreateOrgsInSubtree": false, "adminsCanCreateProjectsInSubtree": false, "allowedClusters": [ "westeurope-1", "asia-northeast1-1" ], "adminGroupId": "my-external-group" }

Path Parameters

org

string

required

ID of an organization The ID of an organization

Required string length: 3 - 64

Pattern: ^([a-z][a-z0-9-]{1,62}[a-z0-9])$

Example:

"my-org"

Response

200 - application/json

An organization

string

required

The ID of an organization

Required string length: 3 - 64

Pattern: ^([a-z][a-z0-9-]{1,62}[a-z0-9])$

Example:

"my-org"

parentId

string

required

The ID of an organization

Required string length: 3 - 64

Pattern: ^([a-z][a-z0-9-]{1,62}[a-z0-9])$

Example:

"my-org"

idp

object

required

Configuration for an external OIDC-compliant IdP.

Show child attributes

adminsCanCreateOrgsInSubtree

boolean

default:false

required

Whether admins of the new organization are allowed to create organizations in the subtree of the organization.

adminsCanCreateProjectsInSubtree

boolean

default:false

required

Whether admins of the new organization are allowed to create CDF projects in the subtree of the organization.

allowedClusters

string[]

required

The clusters on which the admins of the organization will be able to create projects. This must be a (non-strict) subset of the allowedClusters set of the parent organization.

A CDF cluster name

Required string length: 1 - 32

Pattern: ^[a-z0-9-]{1,32}$

Example:

["westeurope-1", "asia-northeast1-1"]

adminGroupId

string

The ID of the externally managed group that contains the organization's admins.

Required string length: 3 - 64

Example:

"my-external-group"

Documentation Index

Path Parameters

Response