List SQL users for a cluster.

Sort order: Username

GET /api/v1/clusters/{cluster_id}/sql-users

cURL

cURL

curl --request GET \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/sql-users \
  --header 'Authorization: Bearer <token>'

200

{
  "users": [
    {
      "name": "<string>"
    }
  ],
  "pagination": {
    "next": "<string>",
    "last": "<string>",
    "limit": 123,
    "time": "2023-11-07T05:31:56Z",
    "order": "ASC"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id · string · required

Query Parameters

pagination.start_key · string

pagination.direction · enum<string> · default: PAGE_DIRECTION_NEXT

Available options: PAGE_DIRECTION_NEXT, PAGE_DIRECTION_LAST

pagination.limit · integer<int32>

pagination.time · string<date-time>

pagination.order · enum<string> · default: ASC

• DESC: Sort in descending order. The default order is ascending.

Available options: ASC, DESC

Response

200

application/json

A successful response.

users · object[] · required

Show child attributes

pagination · object

Show child attributes