How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cognite Organizations API

An **organization** is used to group CDF projects and facilitate their management.An organization holds users, projects, and perhaps other organizations. The organization ID is what the users enterwhen logging into Cognite apps, such as Cognite Data Fusion. The organization has one IdP configuration, which is usedfor both interactive login and service account authentication against all projects in the organization.### External identity providers (IdP)CDF supports interfacing with external IdPs to manage users and groups. The following vendors are supported:- Microsoft Entra ID (formerly known as Azure AD or Azure Active Directory)- Auth0- Keycloak### UsersIf a user can log into the external IdP configured for the organization, then they have access to the CDF organization.Which of the organization's projects they have access to, and what they may do inside those projects, is determined bythe access settings within each project.After a user has logged into the organization for the first time, they will be visible in the organization's user list.Users can see each other, which enables them to collaborate on projects.### Organization hierarchyAn organization can have child organizations. The ownership relationship is materialized through the `parentId`field of the organization resource.### ProjectsAn organization holds CDF projects. The users that are logged into the organization can see all the projects in theorganization, but what they can actually do within each project is controlled by the project's access control lists(ACLs) and other access control settings.### Allowed clustersAn organization has a list of clusters on which it can hold projects. This is the `allowedClusters` field on theresource.### Organization adminsAn organization can have admins, which are identified principals that can perform an extended set of modifications onthe organization, such as creating projects, changing who the admins are, and so on.Admins are identified by the `adminGroupId` field on the organization resource, which is the ID of a group that ismanaged in the external IdP.The different organization API endpoints have different access rules, which are documented under each endpoint.The general rule is that admins of a given organization have control over most aspects of the organization itselfand full control of any sub-organizations.### Authentication for this APIOrganizations are global, which means that they are not tied to specific projects or clusters.API requests against organizations are directed to `auth.cognite.com`, instead of a specific cluster and projectsas for other resources.Only OAuth tokens issued by `https://auth.cognite.com` (such as the ones issued when logging into Fusion) are acceptedby the organizations API.It is also possible to obtain a token by initiating a login flow against the authorization server directly. Seethe "Authorizations" sections for more information.

Cognite Organizations API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organization. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.

4 operations 3 paths 15 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Resource Areas
1

Authentication & Security 5

Cognite Organizations API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token). It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope. It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • oidc-token — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-client-credentials — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-auth-code — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-open-industrial-data — Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
  • org-oidc-token — Access token issued by the Cognite authorization server, and valid for the target organization. The token must be an OpenID Connect token, and it can be obtain…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Organizations 4

An organization is used to group CDF projects and facilitate their management. An organization holds users, projects, and perhaps other organizations. The organization ID is what…

POST
/api/v1/orgs/{org}/orgs
Create an organization
createChildOrg 1 param body → 201403
GET
/api/v1/orgs/{org}/orgs
List child organizations
listChildOrgs 1 param → 200
GET
/api/v1/orgs/{org}
Retrieve an organization
getOrg 1 param → 200
POST
/api/v1/orgs/{org}/delete
Delete an organization
deleteOrg 1 param → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Organization (7 properties), OrganizationRequestItem (6 properties), ExtraAuthParameter (2 properties), IdpBase (1 property). Each schema is shown below with its type and property counts.

OrganizationWithContactPersons
IdpBase
object
1 property 1 required
OrgId
string
The ID of an organization
ClusterName
string
A CDF cluster name
OrganizationRequestItem
object
6 properties 2 required
ExtraAuthParameter
object
Extra parameters to send to the external IdP
2 properties 2 required
ExternalGroupId
string
The ID of a group managed by the external identity provider
IdentityProvider
Configuration for an external OIDC-compliant IdP.
AWSCognitoIdP
SAuthIdp
KeycloakIdp
Auth0Idp
Organization
object
An organization
7 properties 6 required
AzureAdIdp
OktaIdP

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-organizations-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite Organizations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.