Skip to main content
GET
/
v1
/
indexes
/
{index_name}
/
users
List Users
curl --request GET \
  --url https://api.example.com/v1/indexes/{index_name}/users
List the users provisioned for a specific index. Requires RBAC enabled and the root API key.
See Multi-Tenancy & RBAC for the full operator playbook.

​
Authentication

Required — root API key in the X-API-Key header: 
X-API-Key: cyborg_your_root_api_key_here

​
Path Parameters

ParameterTypeDescription
index_namestringName of the index to list users for.

​
Headers

HeaderTypeDescription
X-Index-Keystring(Optional) 32-byte index KEK as a hex string. Required for SDK-supplied indexes (provider: none). Omit for KMS-backed indexes — the service resolves the KEK via the stored KMSBlob.
GET/DELETE on this resource have no request body, so the index key travels in the X-Index-Key header. The sibling POST /v1/indexes/{index_name}/users endpoint takes the same key as an index_key field in its JSON body.

​
Response

{
  "users": [
    {
      "user_id": "a1b2c3d4...",
      "permissions": ["read", "write"]
    },
    {
      "user_id": "e5f6a7b8...",
      "permissions": ["read"]
    }
  ]
}

​
Exceptions

  • 401: Authentication failed (invalid root API key).
  • 403: RBAC is not enabled, or the caller is not using the root key.
  • 404: Index not found.
  • 500: Internal server error.

​
Example Usage

curl -X GET "http://localhost:8000/v1/indexes/documents/users" \
     -H "X-API-Key: cyborg_your_root_api_key_here"
SDK-supplied index (legacy path): 
curl -X GET "http://localhost:8000/v1/indexes/documents/users" \
     -H "X-API-Key: cyborg_your_root_api_key_here" \
     -H "X-Index-Key: your_64_character_hex_key_here"