Schema Service
Read Schema
POST
/
v1
/
tenants
/
{tenant_id}
/
schemas
/
read
When a model is written to Permify using the write schema API a schema version will be returned by the API. That schema version can be used to inspect the schema.
Permify Schema needed to be send to API endpoint /v1/schemas/read for configuration of your authorization model on Permify API.
Example Request on Postman
POST /v1/tenants/{tenant_id}/schemas/read"
Path Parameters
tenant_id
string
requiredIdentifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.
Body
application/json
metadata
object
SchemaReadRequestMetadata provides additional information for the Schema Read request. It contains schema_version to specify which version of the schema should be read.
Response
200 - application/json
The response is of type any
.