curl --request GET \
--url https://auth.cognite.com/api/v1/orgs/{org}{
"id": "my-org",
"parentId": "my-org",
"idp": {
"idpVendor": "AZURE_AD",
"issuer": "https://login.microsoftonline.com/some-tenant-id/v2.0"
},
"adminsCanCreateOrgsInSubtree": false,
"adminsCanCreateProjectsInSubtree": false,
"allowedClusters": [
"westeurope-1",
"asia-northeast1-1"
],
"contactPersons": [
{
"id": 123,
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"note": "<string>"
}
],
"migrationStatus": "EXCLUSIVE_LOGIN",
"adminGroupId": "my-external-group",
"isDeleted": false,
"profilesEnabled": true
}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.
curl --request GET \
--url https://auth.cognite.com/api/v1/orgs/{org}{
"id": "my-org",
"parentId": "my-org",
"idp": {
"idpVendor": "AZURE_AD",
"issuer": "https://login.microsoftonline.com/some-tenant-id/v2.0"
},
"adminsCanCreateOrgsInSubtree": false,
"adminsCanCreateProjectsInSubtree": false,
"allowedClusters": [
"westeurope-1",
"asia-northeast1-1"
],
"contactPersons": [
{
"id": 123,
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"note": "<string>"
}
],
"migrationStatus": "EXCLUSIVE_LOGIN",
"adminGroupId": "my-external-group",
"isDeleted": false,
"profilesEnabled": true
}Path Parameters
ID of an organization The ID of an organization
3 - 64^([a-z][a-z0-9-]{1,62}[a-z0-9])$"my-org"
Response
An organization
An organization
The ID of an organization
3 - 64^([a-z][a-z0-9-]{1,62}[a-z0-9])$"my-org"
The ID of an organization
3 - 64^([a-z][a-z0-9-]{1,62}[a-z0-9])$"my-org"
Configuration for an external OIDC-compliant IdP.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
Whether admins of the new organization are allowed to create organizations in the subtree of the organization.
Whether admins of the new organization are allowed to create CDF projects in the subtree of the organization.
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
1 - 32^[a-z0-9-]{1,32}$["westeurope-1", "asia-northeast1-1"]Show child attributes
Show child attributes
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.
EXCLUSIVE_LOGIN The ID of the externally managed group that contains the organization's admins.
3 - 64"my-external-group"
Whether the organization is soft-deleted
Whether user profiles are enabled in this organization. If profiles are enabled, users logged into the organization will be able to see each other.
Was this page helpful?