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 Sessions API

Sessions are used to maintain access to CDF resources for an extended period of time. The methods available to extend a sessions lifetime are client credentials and token exchange.Sessions depend on the project OIDC configuration and may become invalid in the following cases- Project OIDC configuration has been updated through the [update project](#operation/updateProject) endpoint. This action invalidates all of the project's sessions.- The session was invalidated through the identity provider.

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

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

This API exposes 4 operations across 3 paths, and defines 16 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 16 schemas 1 GET3 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 Sessions 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 — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Sessions 4

Sessions are used to maintain access to CDF resources for an extended period of time. The methods available to extend a sessions lifetime are client credentials and token exchange…

GET
/sessions
List sessions
listSessions 3 params → 200400
POST
/sessions
Create sessions
createSessions body → 200400
POST
/sessions/byids
Retrieve sessions with given IDs
getSessionsByIds body → 200400
POST
/sessions/revoke
Revoke sessions
revokeSessions body → 200400

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Session (6 properties), CreateSessionResponse (5 properties), Error (4 properties), SessionList (3 properties). Each schema is shown below with its type and property counts.

CreateSessionResponseList
object
1 property
Session
object
6 properties
SessionReferenceIds
object
1 property 1 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
RevokeSessionRequest
object
1 property 1 required
Error
object
Cognite API error.
4 properties 2 required
RevokeSessionRequestList
object
1 property
CreateSessionWithOneshotTokenExchangeRequest
object
Credentials for a session using one-shot token exchange to reuse the user's credentials. One-shot sessions are short-lived sessions that are not refreshed and…
1 property 1 required
CreateSessionRequest
CreateSessionWithClientCredentialsRequest
object
Credentials for a session using client credentials from an identity provider.
2 properties 2 required
CreateSessionRequestList
object
1 property
CreateSessionWithTokenExchangeRequest
object
Credentials for a session using token exchange to reuse the user's credentials.
1 property 1 required
SessionByIds
object
1 property
CogniteInternalId
integer
A server-generated ID for the object.
CreateSessionResponse
object
A response with the ID, nonce and other information related to the session. The nonce is short-lived and should be immediately passed to the endpoint that will…
5 properties 3 required
SessionList
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-sessions-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 Sessions 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.