Skip to main content
GET
List 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:

Path Parameters

Headers

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

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

SDK-supplied index (legacy path):