Skip to content
You're viewing documentation for v2026.11.9-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

List users with access

Each user (local or OIDC) whose role on the service is viewer or higher: from the default role, from a grant, or both. A disabled user is in the list too.

GET/api/v1/database-services/{id}/access
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Responses
200

OK

Array of ServiceAccessResponse
default_rolestringrequired

The role of the user on the whole console

Allowed:nonevieweroperatoradmin
disabledbooleanrequired
display_namestringrequired
grant_rolestring

The grant of the user on this service, if any

Allowed:vieweroperator
rolestringrequired

The role on this service: the higher of default_role and grant_role

Allowed:vieweroperatoradmin
user_idstringrequired
usernamestringrequired
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/database-services/string/access' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
[
  {
    "default_role": "none",
    "disabled": true,
    "display_name": "string",
    "grant_role": "viewer",
    "role": "viewer",
    "user_id": "string",
    "username": "string"
  }
]