Skip to main content
GET
/
api
/
v1
/
orgs
/
{org}
Retrieve an organization
curl --request GET \
  --url https://auth.cognite.com/api/v1/orgs/{org}
{
  "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"
  ],
  "contactPersons": [
    {
      "id": 123,
      "email": "jsmith@example.com",
      "name": "<string>",
      "phone": "<string>",
      "note": "<string>"
    }
  ],
  "adminGroupId": "my-external-group",
  "isDeleted": false,
  "profilesEnabled": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.cognite.com/llms.txt

Use this file to discover all available pages before exploring further.

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

An organization

​
id
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.

​
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"]
​
contactPersons
object[]
required
​
migrationStatus
enum<string>

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.

Available options:
EXCLUSIVE_LOGIN
​
adminGroupId
string

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

Required string length: 3 - 64
Example:

"my-external-group"

​
isDeleted
boolean
default:false

Whether the organization is soft-deleted

​
profilesEnabled
boolean
default:true

Whether user profiles are enabled in this organization. If profiles are enabled, users logged into the organization will be able to see each other.

Last modified on June 2, 2026