Zitadel Preview Docs

Get schema by ID

Get a schema by its ID. This will return the default revision of the schema.

GET
/schemas/{id}

Get a schema by its ID. This will return the default revision of the schema.

Authorization

oauth2 schema.read
AuthorizationBearer <token>

In: header

Scope: schema.read

Path Parameters

id*string

Query Parameters

project_id*string

The unique identifier of the project

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?project_id=river-8421"
{  "$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,      "position": 0    },    "passkey": {      "enabled": true,      "position": 0    },    "magic_link": {      "enabled": true,      "position": 0    },    "sso": {      "enabled": true,      "position": 0    },    "otp": {      "enabled": true,      "position": 0    }  },  "properties": {    "property1": {      "x-verify": "string",      "x-unique": "unspecified",      "x-claim": "string",      "x-editable": true,      "x-sensitive": false,      "x-mfa": false,      "properties": {}    },    "property2": {      "x-verify": "string",      "x-unique": "unspecified",      "x-claim": "string",      "x-editable": true,      "x-sensitive": false,      "x-mfa": false,      "properties": {}    }  }}
{  "code": "string",  "message": "string",  "details": {}}
{  "code": "string",  "message": "string",  "details": {}}
{  "code": "string",  "message": "string",  "details": {}}