---
title: "Explain Fga Check"
method: POST
path: "/api/platform/service-accounts/{service_account_id}/fga-check/explain"
tags: ["platform"]
---

# Explain Fga Check

`POST /api/platform/service-accounts/{service_account_id}/fga-check/explain`

## Request

- Base URL: `https://app.gocrisp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://app.gocrisp.com/api/platform/service-accounts/{service_account_id}/fga-check/explain`
- Auth: OAuth 2
  - Authorization code: `https://login.gocrisp.com/authorize`
  - Token URL: `https://login.gocrisp.com/oauth/token`

Explain how a service account obtained an FGA relation on an object when allowed.

Runs ``check`` first; when denied, returns ``allowed=false`` with no graph.
When allowed, recursively walks OpenFGA ``expand`` trees pruned to branches
that prove the requested service account.

## Path parameters

- `service_account_id` string, required: Service account whose principal is checked

## Request body

- FgaCheckRequest: Run an FGA ``check`` for a given principal against an arbitrary object.
  - `objectType` string, required
  - `objectId` string, required
  - `relation` string, required

## Response `200`

Successful Response

- FgaCheckExplanationResponse: Proof graph for how a principal obtained an FGA relation on an object.
  - `allowed` boolean, required
  - `user` string, required
  - `relation` string, required
  - `object` string, required
  - `summary` string, nullable
  - `nodes` FgaExplainNode[]
    - `id` string, required
    - `label` string, required
    - `kind` string, required
    - `displayName` string, nullable
  - `edges` FgaExplainEdge[]
    - `fromId` string, required
    - `toId` string, required
    - `label` string, required
  - `truncated` boolean
  - `warnings` string[]

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/gocrisp/apis/crisp-app-dock.md) - [All operations](https://skmtc.dev/gocrisp/apis/crisp-app-dock/llms.txt) - [OpenAPI document](https://skmtc.dev/gocrisp/apis/crisp-app-dock/revisions/28638f87e7d4?raw)
