List users

Lists the tenant's database users with their authentication method, roles and number of API keys.

GET /v1/tenants/{tenant}/db/users

Review database users without exposing secretsKey counts are returned, not the key values.

List database usersRequest accounts in the selected tenant.
Review authentication and rolesCheck each user's method and access assignments.
Inspect account statusRead disabled state and API-key count.

Before you start

Use your database bearer token.

Connection setup

Use an identity authorized to manage access in this tenant.

Path parameters

Field	Type	Required
`tenant`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

Each user shows its roles, disabled state and api_key_count. The response counts keys without returning their secret values.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
429	Honor Retry-After when present; back off.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/db/users" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "users": [
    {
      "username": "demo_user",
      "auth": "api_key",
      "roles": [
        "demo_reader"
      ],
      "disabled": false,
      "api_key_count": 1,
      "created_unix": 1793318400
    }
  ]
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses