Users

Use these operations to list users in your Cortex workspace along with their profile metadata, and to retrieve their role assignments.

Required permissions

Your API token must have the View Roles permission.

Some built-in API key roles (VIWER, USER, and MANAGER) do not include View Roles. To call this endpoint with an API key, use an ADMIN key or create a new one and assign it a custom role that grants View Roles.

Operations

List users

get

Returns every user in your Cortex tenant along with their profile metadata: name, email, join date, and last active timestamp. Intended for access reviews, compliance, and auditing. Role assignments are available from the separate GET /api/v1/users/roles endpoint. Requires the View Roles permission; assign it to a custom role to issue a least-privilege API key for automated reporting.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters

emailstring[]Optional

Filter to specific users by email. Provide a comma-separated list to request multiple users (e.g. ?email=[e-mail],[e-mail]). Matching is case-insensitive. Omit to return all users.

pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250

pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0

Responses

200

Successfully retrieved users

application/json

pageinteger · int32Required

Current page number, 0-indexed

totalinteger · int32Required

Total number of results

totalPagesinteger · int32Required

Total number of pages

401

Authentication required

application/json

403

Caller does not have the View Roles permission

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get/api/v1/users

HTTPcURLJavaScriptPython

GET /api/v1/users?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "users": [
    {
      "email": "text",
      "joinedAt": "2024-01-15T08:00:00Z",
      "lastActiveAt": "2024-06-10T14:45:00Z",
      "name": "text"
    }
  ]
}

List user role assignments

get

Returns the role assignments for every user in your Cortex tenant, intended for access reviews and access governance reporting. Each entry lists the user along with their assigned built-in (BASIC) and CUSTOM roles. Requires the View Roles permission; assign it to a custom role to issue a least-privilege API key for automated reporting.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters

emailstring[]Optional

Filter to specific users by email. Provide a comma-separated list to request multiple users (e.g. ?email=[e-mail],[e-mail]). Matching is case-insensitive. Omit to return all users.

pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250

pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0

Responses

200

Successfully retrieved user role assignments

application/json

pageinteger · int32Required

Current page number, 0-indexed

totalinteger · int32Required

Total number of results

totalPagesinteger · int32Required

Total number of pages

401

Authentication required

application/json

403

Caller does not have the View Roles permission

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get/api/v1/users/roles

HTTPcURLJavaScriptPython

GET /api/v1/users/roles?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "users": [
    {
      "email": "text",
      "name": "text",
      "roles": [
        {
          "name": "text",
          "role": "text",
          "tag": "text",
          "type": "BASIC"
        }
      ]
    }
  ]
}