curl

# Set FGA_API_URL to your store region (https://api.us1.fga.dev, or eu1/au1).
# Set FGA_STORE_ID and obtain FGA_BEARER_TOKEN with the client credentials grant.
# See /integration/getting-your-api-keys; never put client secrets in source code.

curl -X GET "$FGA_API_URL/stores/$FGA_STORE_ID/indexes?page_size=20" \
  -H "authorization: Bearer $FGA_BEARER_TOKEN"

{
  "continuation_token": "<string>",
  "indexes": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "expansion_factor": 123,
      "expansions_count": "<string>",
      "expansions_events_count": "<string>",
      "freshness": "2023-11-07T05:31:56Z",
      "index_id": "<string>",
      "models": [
        {
          "assigned_at": "2023-11-07T05:31:56Z",
          "model_id": "<string>"
        }
      ],
      "name": "<string>",
      "relations": [
        {
          "object_type": "<string>",
          "relation": "<string>"
        }
      ],
      "status": "<string>",
      "total_ingested_changes": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "code": "validation_error",
  "message": "Generic validation error"
}

{
  "code": "unauthorized_principal",
  "message": "Missing permissions to perform operation"
}

{
  "code": "unauthorized_principal",
  "message": "Missing permissions to perform operation"
}

{
  "code": "undefined_endpoint",
  "message": "Endpoint not enabled"
}

{
  "code": "10",
  "message": "transaction conflict"
}

{
  "code": "throttled_timeout_error",
  "message": "timeout due to throttling on complex request"
}

{
  "code": "rate_limit_exceeded",
  "message": "Rate Limit exceeded"
}

{
  "code": "internal_error",
  "message": "Internal Server Error"
}

Permissions Index

List permissions indexes for a store

The ListIndexes API returns a paginated list of all permissions indexes for a given store. This API is paginated. If there is more than one page of indexes to list, the response includes a continuation_token that can be passed, as the continuation_token parameter on a subsequent request, to retrieve the next page of results. The continuation token will be empty if there are no more pages.

Example

List all indexes for a store

To list indexes for store 01G5JAVJ41T49E9TT3SKVS7X1J, call the ListIndexes API. The response:

{
  "indexes": [
    {
      "index_id": "01YCP46JKYM8FJCQ37NMBYHE5X",
      "name": "document#viewer",
      "status": "ACTIVE",
      "models": [
        {
          "model_id": "01KPXNXCSD67G2T4MNWHQ35TJ6",
          "assigned_at": "2024-01-15T10:00:00Z"
        }
      ],
      "relations": [
        { "object_type": "document", "relation": "viewer" }
      ],
      "total_ingested_changes": 12450,
      "expansions_count": 37350,
      "expansions_events_count": 237350,
      "expansion_factor": 3.0,
      "freshness": "2024-01-15T10:05:00Z",
      "created_at": "2024-01-15T09:00:00Z",
      "updated_at": "2024-01-15T10:05:00Z"
    }
  ],
  "continuation_token": "eyJpZCI6IjAxWUNQNDZKS1lNOEZKQ1EzN05NQllIRTVYIn0="
}

To retrieve the next page, pass the continuation_token in the subsequent request. Repeat this process until the API returns a response with an empty continuation_token.

GET

stores

{store_id}

indexes

curl

# Set FGA_API_URL to your store region (https://api.us1.fga.dev, or eu1/au1).
# Set FGA_STORE_ID and obtain FGA_BEARER_TOKEN with the client credentials grant.
# See /integration/getting-your-api-keys; never put client secrets in source code.

curl -X GET "$FGA_API_URL/stores/$FGA_STORE_ID/indexes?page_size=20" \
  -H "authorization: Bearer $FGA_BEARER_TOKEN"

{
  "continuation_token": "<string>",
  "indexes": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "expansion_factor": 123,
      "expansions_count": "<string>",
      "expansions_events_count": "<string>",
      "freshness": "2023-11-07T05:31:56Z",
      "index_id": "<string>",
      "models": [
        {
          "assigned_at": "2023-11-07T05:31:56Z",
          "model_id": "<string>"
        }
      ],
      "name": "<string>",
      "relations": [
        {
          "object_type": "<string>",
          "relation": "<string>"
        }
      ],
      "status": "<string>",
      "total_ingested_changes": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "code": "validation_error",
  "message": "Generic validation error"
}

{
  "code": "unauthorized_principal",
  "message": "Missing permissions to perform operation"
}

{
  "code": "unauthorized_principal",
  "message": "Missing permissions to perform operation"
}

{
  "code": "undefined_endpoint",
  "message": "Endpoint not enabled"
}

{
  "code": "10",
  "message": "transaction conflict"
}

{
  "code": "throttled_timeout_error",
  "message": "timeout due to throttling on complex request"
}

{
  "code": "rate_limit_exceeded",
  "message": "Rate Limit exceeded"
}

{
  "code": "internal_error",
  "message": "Internal Server Error"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

store_id

string

required

Query Parameters

page_size

integer<int32>

The maximum number of indexes to return per page. Must be between 1 and 100. Defaults to 10 if not specified.

continuation_token

string

Opaque pagination token for retrieving the next page of results. Empty for the first page.

Response

A successful response.

continuation_token

string

Token to retrieve the next page of results. Empty if no more results.

indexes

Response containing index details · object[]

Show child attributes

Assertions

Authorization Models

Relationship Queries

Relationship Tuples

Permissions Index

Logs

List permissions indexes for a store

Example

List all indexes for a store

Authorizations

Path Parameters

Query Parameters

Response