k0rdent AI Docs

List users of an organization.

Visibility: public · internal ( OpenAPI Custom Extension: x-visibility )

List all users in the organization. If Operator user is making the request, orgId in filter is to be used. Should pass "*" for orgId to list users across all organizations. Supports pagination and filtering by email, status, and role.

GET
/v1/regions/global/iam/users

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication using OAuth2/OIDC tokens

In: header

Query Parameters

orgId?string

Organization identifier. Used by operator admins to filter by a specific organization. Pass "*" to list across all organizations. If not specified, defaults to the current user's organization.

filter?string

Filter expression for user search (e.g., by email, status, role)

pageToken?string

Opaque cursor token returned in the previous response's nextPageToken. Pass to retrieve the next page of results.

Use for: Frequently updated resources (sessions, servers, clusters, API keys, instances, networks, addresses) where cursor pagination prevents items from being skipped or duplicated when the dataset changes between requests.

Mutually exclusive with offset — include one or the other, not both.

pageSize?integer

Maximum number of items to return per page. Applies to both cursor-based and offset-based pagination.

Range: 1–500. Default: 50.

Default50
Range1 <= value <= 500
offset?integer

Number of items to skip before returning results.

Use for: Stable resources that change infrequently (roles, organizations, providers, policies, groups, projects) where offset pagination enables page-number UIs and total-count displays.

When using offset, the response includes a total field with the full item count. Mutually exclusive with pageToken — include one or the other, not both.

Default0
Range0 <= value

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.k0rdent.ai/v1/regions/global/iam/users"
{
  "users": [
    {
      "selfLink": "/v1/regions/global/iam/users/user-v5w6x7",
      "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
      "id": "user-v5w6x7",
      "email": "user@example.com",
      "displayName": "string",
      "roles": [
        "string"
      ],
      "status": "active",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextPageToken": "string",
  "total": 0
}
{
  "error": {
    "code": 0,
    "message": "string",
    "details": [
      {}
    ]
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "details": [
      {}
    ]
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "details": [
      {}
    ]
  }
}

How is this guide?

On this page

No Headings