Refactor identity traits schema to identity schema #531
Assignees
Labels
Milestone
Comments
aeneasr
added
feat
aeneasr
added a commit
that referenced
this issue
Jul 7, 2020
Closes #531 BREAKING CHANGE: This patch renames the Identity Traits JSON Schema to Identity JSON Schema. The identity payload has changed from ``` { - "traits_schema_url": "...", - "traits_schema_id": "...", + "schema_url": "...", + "schema_id": "...", } ``` Additionally, it is now expected that your Identity JSON Schema includes a "traits" key at the root level. **Before (example)** ``` { "$id": "https://schemas.ory.sh/presets/kratos/quickstart/email-password/identity.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Person", "type": "object", "properties": { "email": { "type": "string", "format": "email", "title": "E-Mail", "minLength": 3, "ory.sh/kratos": { "credentials": { "password": { "identifier": true } }, "verification": { "via": "email" }, "recovery": { "via": "email" } } } }, "required": [ "email" ], "additionalProperties": false } ``` **After (example)** ``` { "$id": "https://schemas.ory.sh/presets/kratos/quickstart/email-password/identity.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Person", "type": "object", "properties": { "traits": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "title": "E-Mail", "minLength": 3, "ory.sh/kratos": { "credentials": { "password": { "identifier": true } }, "verification": { "via": "email" }, "recovery": { "via": "email" } } } }, "required": [ "email" ], "additionalProperties": false } } } ``` You also need to remove the `traits` key from your ORY Kratos config like this: ``` identity: - traits: - default_schema_url: http://test.kratos.ory.sh/default-identity.schema.json - schemas: - - id: other - url: http://test.kratos.ory.sh/other-identity.schema.json + default_schema_url: http://test.kratos.ory.sh/default-identity.schema.json + schemas: + - id: other + url: http://test.kratos.ory.sh/other-identity.schema.json ``` Do not forget to also update environment variables for the Identity JSON Schema as well if set.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
We currently have an identity traits schema. However, as requests for more fields (e.g. keeping track of subscription status) that are not under the user's control appear, it probably makes sense to change this.
Describe the solution you'd like
Rename "Identity Traits Schema" to "Identity Schema" and change config keys as well as JSON Schema nesting.
Describe alternatives you've considered
Multiple schemas.
The text was updated successfully, but these errors were encountered: