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

Groups are used to give principals the capabilities to access CDF resources.One principal can be a member in multiple groups and one group can have multiple members. Note that having more than 20 groups per principal is not supported and may result in login issues.Groups can either be managed through the external identity provider for the project or managed by CDF.- **Group Membership Managed Externally**: Groups membership is managed by the external identity provider. It is not possible edit or see the members of these groups in CDF.- **Group Membership Managed within CDF**: Lets you see and edit group membership in CDF instead of relying on the external identity provider.

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

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

This API exposes 3 operations across 2 paths, and defines 148 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}.

3 operations 2 paths 148 schemas 1 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 Groups 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 3

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

Groups 3

Groups are used to give principals the capabilities to access CDF resources. One principal can be a member in multiple groups and one group can have multiple members. Note that ha…

GET
/groups
List groups
getGroups 1 param → 200
POST
/groups
Create groups
createGroups body → 201400
POST
/groups/delete
Delete groups
deleteGroups body → 200

Schemas 148

The contract defines 148 schemas that model the data the API accepts and returns. The most detailed are GroupBase (4 properties), cognitedataproducts_aclAcl (2 properties), cognitedatamodelinstances_aclAcl (2 properties), streams_aclAcl (2 properties). Each schema is shown below with its type and property counts.

GroupMetadata
object
Custom, immutable application specific metadata. String key - String value. Limits: Key are at most 32 bytes. Values are at most 512 bytes. Up to 16 key-value…
cognitesequences_aclScope
object
extractionpipelines_aclAction
string
cogniteanalytics_aclAcl
object
2 properties 2 required
cognitesequences_aclAction
string
GroupSourceId
string
ID of the group in the source. If this is the same ID as a group in the IdP, a principal in that group will implicitly be a part of this group as well.
cognitegroups_aclAcl
object
2 properties 2 required
annotations_aclScope
object
cognitedigitaltwin_aclAcl
object
2 properties 2 required
limits_aclAction
string
cognitedatamodels_aclScope
object
streams_aclAction
string
cognitegeospatial_aclAcl
object
2 properties 2 required
extractionruns_aclAction
string
DataGroupSpec
object
1 property 1 required
cognitedatasets_aclIdScope
object
1 property
cognitetypes_aclScope
object
1 property
cogunits_aclAcl
object
2 properties 2 required
GroupTokenAttributes
object
Attributes derived from access token.
1 property
cognitetimeseries_aclAction
string
simulators_aclAction
string
locationfilters_aclScope
object
cogniteassets_aclAcl
object
2 properties 2 required
cogniteevents_aclAction
string
cogniteraw_aclScope
object
GroupBase
object
4 properties 1 required
cognitesecuritycategories_aclScope
object
cognitedatamodels_aclAction
string
cognitelabels_aclAction
string
cognitedataproducts_aclDataProductScope
object
1 property
entitymatching_aclAcl
object
2 properties 2 required
agents_aclScope
object
1 property
cognitedigitaltwin_aclAction
string
locationfilters_aclAcl
object
2 properties 2 required
cogniterobotics_aclAction
string
GroupSpec
A specification for creating a new group
cogunits_aclAction
string
entitymatching_aclScope
object
cognitetimeseries_aclScope
object
extractionruns_aclScope
object
cognitetransformations_aclAction
string
cognitegeospatial_aclAction
string
ProjectUrlName
string
The URL name of the project. This is used as part of the request path in API calls. Valid URL names contains between 3 and 32 characters, and may only contain…
cognitetimeseriessubscriptions_aclScope
object
cognitegeospatialcrs_aclAction
string
generic_aclAllScope
object
cognitetimeseries_aclAcl
object
2 properties 2 required
cogniterelationships_aclAcl
object
2 properties 2 required
cognitediagramparsing_aclAcl
object
2 properties 2 required
cogniteprojects_aclAcl
object
2 properties 2 required
cogniterobotics_aclScope
object
hostedextractors_aclAcl
object
2 properties 2 required
DataLong
object
1 property 1 required
streamrecords_aclAcl
object
2 properties 2 required
GroupMembershipManagedExternallyOrInCdf
cognitediagramparsing_aclScope
object
cognitetransformations_aclAcl
object
2 properties 2 required
cogniteprojects_aclScope
object
1 property
cognitethreed_aclScope
object
DataGroup
object
1 property 1 required
cogniteassets_aclAction
string
locationfilters_aclAction
string
cognitetypes_aclAcl
object
2 properties 2 required
cognitegeospatialcrs_aclAcl
object
2 properties 2 required
cogniterelationships_aclAction
string
cogniterobotics_aclAcl
object
2 properties 2 required
cognitesecuritycategories_aclAction
string
locationfilters_aclIdScope
object
1 property
cognitesecuritycategories_aclIdScope
object
1 property
cogniteseismic_aclAction
string
functions_aclAction
string
streams_aclScope
object
cognitethreed_aclAction
string
functions_aclAcl
object
2 properties 2 required
CogniteCapability
array
cognitetransformations_aclScope
object
simulators_aclScope
object
cognitegroups_aclAction
string
cogniteseismic_aclScope
object
1 property
generic_aclCurrentUserScope
object
cognitedatamodelInstances_aclAction
string
hostedextractors_aclScope
object
GroupName
string
Name of the group
cogniteprojects_aclAction
string
entitymatching_aclAction
string
streamrecords_aclAction
string
cognitefiles_aclScope
object
annotations_aclAcl
object
2 properties 2 required
sessions_aclAction
string
sessions_aclScope
object
cognitegeospatialcrs_aclScope
object
1 property
cognitegroups_aclScope
object
cognitedatamodels_aclSpaceIdScope
object
1 property
cognitetimeseries_aclAssetRootIdScope
object
1 property
cognitegeospatial_aclScope
object
1 property
agents_aclAcl
object
2 properties 2 required
cognitedataproducts_aclAcl
object
2 properties 2 required
limits_aclScope
object
1 property
cognitedatamodelinstances_aclAcl
object
2 properties 2 required
cognitedatamodels_aclAcl
object
2 properties 2 required
cognitetypes_aclAction
string
cognitetimeseriessubscriptions_aclAcl
object
2 properties 2 required
functions_aclScope
object
1 property
cognitedatasets_aclAction
string
cognitedataproducts_aclScope
object
cognitedatasets_aclAcl
object
2 properties 2 required
cogniterelationships_aclScope
object
cogunits_aclScope
object
cogniteraw_aclAction
string
cognitefiles_aclAcl
object
2 properties 2 required
PrincipalId
string
Unique identifier of a principal
extractionpipelines_aclIdScope
object
1 property
extractionruns_aclAcl
object
2 properties 2 required
cogniteseismic_aclAcl
object
2 properties 2 required
cognitelabels_aclScope
object
cogniteWorkflowOrchestration_aclScope
object
cogniteanalytics_aclAction
string
cognitesequences_aclAcl
object
2 properties 2 required
extractionpipelines_aclAcl
object
2 properties 2 required
cogniteWorkflowOrchestration_aclAcl
object
2 properties 2 required
cognitesecuritycategories_aclAcl
object
2 properties 2 required
cognitefiles_aclAction
string
cognitedatasets_aclScope
object
cognitetimeseries_aclIdScope
object
1 property
Group
annotations_aclAction
string
simulators_aclAcl
object
2 properties 2 required
cognitedigitaltwin_aclScope
object
1 property
extractionpipelines_aclScope
object
hostedextractors_aclAction
string
cogniteevents_aclScope
object
cognitedataproducts_aclAction
string
sessions_aclAcl
object
2 properties 2 required
cogniteraw_aclAcl
object
Set access control on RAW
2 properties 2 required
cogniteevents_aclAcl
object
2 properties 2 required
streamrecords_aclScope
object
cogniteWorkflowOrchestration_aclAction
string
cogniteanalytics_aclScope
object
1 property
GroupAttributes
object
Set Attributes for the group.
1 property
cogniteassets_aclScope
object
cognitetimeseriessubscriptions_aclAction
string
agents_aclAction
string
streams_aclAcl
object
2 properties 2 required
cognitediagramparsing_aclAction
string
cognitelabels_aclAcl
object
2 properties 2 required
cogniteraw_aclDbsToTablesScope
object
Scope access to certain tables within a database
1 property
cognitethreed_aclAcl
object
2 properties 2 required
limits_aclAcl
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-groups-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 Groups 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.