Zitadel Preview Docs
API referenceSchemas

Get schema by ID

Get a schema by its ID. A schema ID identifies one immutable revision, so this returns exactly that revision. To find the current revision of an object type, list with `revisions=latest`.

GET
/schemas/{id}

Get a schema by its ID. A schema ID identifies one immutable revision, so this returns exactly that revision. To find the current revision of an object type, list with revisions=latest.

Authorization

oauth2 schema.read
AuthorizationBearer <token>

In: header

Scope: schema.read

Path Parameters

id*string

Query Parameters

team_id?string

The unique identifier of the team

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/schemas/string"
{  "id": "sch_01H455VB4213EF62K49QF6M73F",  "schema": {    "$schema": "https://json-schema.org/draft/2020-12/schema",    "objectType": "human-user",    "kind": "user-schema",    "metaSchema": "http://example.com",    "x-auth-methods": {      "password": {        "enabled": true      },      "passkey": {        "enabled": true      },      "magic_link": {        "enabled": true      },      "sso": {        "enabled": true      },      "otp": {        "enabled": true      }    },    "properties": {      "property1": {        "x-unique": "unspecified",        "x-claim": "string",        "x-audit": false,        "properties": {          "property1": {            "x-unique": "unspecified",            "x-claim": "string",            "x-audit": false,            "properties": {}          },          "property2": {            "x-unique": "unspecified",            "x-claim": "string",            "x-audit": false,            "properties": {}          }        }      },      "property2": {        "x-unique": "unspecified",        "x-claim": "string",        "x-audit": false,        "properties": {          "property1": {            "x-unique": "unspecified",            "x-claim": "string",            "x-audit": false,            "properties": {}          },          "property2": {            "x-unique": "unspecified",            "x-claim": "string",            "x-audit": false,            "properties": {}          }        }      }    }  },  "metadata": {    "created_at": "2019-08-24T14:15:22Z"  }}
{  "code": "string",  "message": "string",  "details": {}}
{  "code": "string",  "message": "string",  "details": {}}
{  "code": "string",  "message": "string",  "details": {}}

Create new schema POST

Create a new schema. The optional `$id` field is the JSON Schema document URI used to identify the schema in future requests (GitOps-stable identity, not a free-form resource primary key). When `$id` is omitted, the server generates a `sch_*` URL. When provided, `$id` must be unique within the project and should ideally be a valid URI pointing at where the schema can be accessed. The schema can either be a concrete schema, e.g. a user schema, or a schema-url which will be resolved by the server.

System

OpenAPI operations for server health, liveness, and readiness probes.