Section ID:
DOC-API-MODEL-schema-pqjdejpl2g#overview
TupleKey
TupleKey represents a relationship tuple: user -relation-> object This is the fundamental data model in OpenFGA
Type-reference view: API Schema 62ajd5h7r5. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#request-field-useruser | string | Optional | User identifier (e.g., "user:alice", "team:engineering"). |
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#request-field-relationrelation | string | Optional | Relation name (e.g., "owner", "editor", "viewer"). |
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#request-field-objectobject | string | Optional | Object identifier (e.g., "document:doc1"). |
In responses
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#field-userSection ID: DOC-API-MODEL-schema-pqjdejpl2g#response-field-useruser | string | Optional | User identifier (e.g., "user:alice", "team:engineering"). |
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#field-relationSection ID: DOC-API-MODEL-schema-pqjdejpl2g#response-field-relationrelation | string | Optional | Relation name (e.g., "owner", "editor", "viewer"). |
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#field-objectSection ID: DOC-API-MODEL-schema-pqjdejpl2g#response-field-objectobject | string | Optional | Object identifier (e.g., "document:doc1"). |
Where used
Section ID: DOC-API-MODEL-schema-pqjdejpl2g#where-used
| Reference | Relationship |
|---|---|
| TupleKey | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-pqjdejpl2g