Section ID:
DOC-API-MODEL-schema-pq9d837o76#overview
AuthorizationModel
AuthorizationModel represents the schema/DSL defining types, relations, and rules Models define what relationships are possible in the authorization system
Type-reference view: API Schema 6up6drbioc. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-pq9d837o76#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-pq9d837o76#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-pq9d837o76#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-pq9d837o76#request-field-idid | string | Optional | Model ID/version identifier. |
Section ID: DOC-API-MODEL-schema-pq9d837o76#request-field-schemaversionschemaVersion | string | Optional | FGA schema version (e.g., "1.1"). |
Section ID: DOC-API-MODEL-schema-pq9d837o76#request-field-typedefinitionstypeDefinitions | string | Optional | FGA DSL defining types and relations. |
Section ID: DOC-API-MODEL-schema-pq9d837o76#request-field-createdatcreatedAt | string (date-time) | Optional | When this model was created. |
Section ID: DOC-API-MODEL-schema-pq9d837o76#request-field-metadatametadata | Map from string to JSON value | Optional | Additional metadata as key-value pairs. |
In responses
Section ID: DOC-API-MODEL-schema-pq9d837o76#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-pq9d837o76#field-idSection ID: DOC-API-MODEL-schema-pq9d837o76#response-field-idid | string | Optional | Model ID/version identifier. |
Section ID: DOC-API-MODEL-schema-pq9d837o76#field-schemaversionSection ID: DOC-API-MODEL-schema-pq9d837o76#response-field-schemaversionschemaVersion | string | Optional | FGA schema version (e.g., "1.1"). |
Section ID: DOC-API-MODEL-schema-pq9d837o76#field-typedefinitionsSection ID: DOC-API-MODEL-schema-pq9d837o76#response-field-typedefinitionstypeDefinitions | string | Optional | FGA DSL defining types and relations. |
Section ID: DOC-API-MODEL-schema-pq9d837o76#field-createdatSection ID: DOC-API-MODEL-schema-pq9d837o76#response-field-createdatcreatedAt | string (date-time) | Optional | When this model was created. |
Section ID: DOC-API-MODEL-schema-pq9d837o76#field-metadataSection ID: DOC-API-MODEL-schema-pq9d837o76#response-field-metadatametadata | Map from string to JSON value | Optional | Additional metadata as key-value pairs. |
Where used
Section ID: DOC-API-MODEL-schema-pq9d837o76#where-used
| Reference | Relationship |
|---|---|
| AuthorizationModel | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-pq9d837o76