Create an organizationDeprecated

Create a child organization under the specified organization.

Access control

Requires the caller to be an admin in the parent organization (i.e. the one on the path), or any of its ancestors. In addition, the flag adminsCanCreateOrgsInSubtree must be set to true in that organization.

Example: Assume an organization hierarchy like: org-a -> org-b -> org-c. To create a new organization under org-c, which means calling 'POST /api/admin/orgs/org-c/orgs', the caller must be an admin in org-a, org-b, or org-c. Also, adminsCanCreateOrgsInSubtree must be true in that same organization.

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
Request Body schema: application/json
required

A request to create an organization.

id
required
string [ 3 .. 64 ] characters ^([a-z][a-z0-9-]{1,62}[a-z0-9])$

The ID of the new organization

required
AzureAdIdp (object) or Auth0Idp (object) or KeycloakIdp (object) or SAuthIdp (object) (IdentityProvider)
migrationStatus
string (MigrationStatus)

This attribute will be removed in a future version, and it is recommended to not send it in requests and to ignore it in responses. If it is present, the single valid value is equivalent to the attribute being null or absent.

Value: "EXCLUSIVE_LOGIN"
adminGroupId
string [ 3 .. 64 ] characters
Default: null

The ID of a group managed by the external identity provider

adminsCanCreateOrgsInSubtree
boolean
Default: false

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

adminsCanCreateProjectsInSubtree
boolean
Default: false

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

allowedClusters
Array of strings (ClusterName)
Default: []

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.

Responses
201

A successfully created organization

403

Creation forbidden: The caller is not allowed to create sub-organizations.

post/api/admin/orgs/{org}/orgs
Request samples
application/json
{
  • "id": "my-org",
  • "idp": {},
  • "migrationStatus": "EXCLUSIVE_LOGIN",
  • "adminGroupId": "my-external-group",
  • "adminsCanCreateOrgsInSubtree": false,
  • "adminsCanCreateProjectsInSubtree": false,
  • "allowedClusters": [
    • "westeurope-1",
    • "asia-northeast1-1"
    ]
}
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
}
➔ Next to Create an organization