Skip to main content
GET
/
api
/
v1
/
orgs
/
{org}
/
principals
List principals
curl --request GET \
  --url https://auth.cognite.com/api/v1/orgs/{org}/principals
{
  "items": [
    {
      "id": "5yAFQRAATb7vtWGp4gvbJD3wE7VS81CGuQ7EZT",
      "type": "SERVICE_ACCOUNT",
      "name": "My service account",
      "createdBy": {
        "orgId": "my-org",
        "userId": "-user-string-id-aBc123"
      },
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "pictureUrl": "<string>",
      "externalId": "my.known.id",
      "description": "This is a service account used by data pipeline A-xxx"
    }
  ],
  "nextCursor": {
    "cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
  }
}

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"

Query Parameters

​
cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example:

"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"

​
limit
integer
Required range: 1 <= x <= 100
​
types
enum<string>

Filter by principal types. If not specified, all principal types will be included. You can filter by multiple types by providing a comma-separated list, or by repeating the parameter. The type of a principal

Available options:
SERVICE_ACCOUNT,
USER

Response

200 - application/json

A list of principals, with a cursor pointing to the next results page (if any).

​
items
object[]
required

A principal

​
nextCursor
object

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Last modified on June 2, 2026