Identity schema and validation of booleans

[adrianrudnik]

How do you validate a "accepted_tos" boolean like the one mentioned in https://www.ory.sh/docs/kratos/concepts/identity-schema

I'm trying to add it to the "Username & Password" cloud default schema, ending up with something like:

{
  "$id": "https://schemas.ory.sh/presets/kratos/identity.username.schema.json",
  "title": "Person",
  "type": "object",
  "properties": {
    "traits": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "title": "Username",
          "maxLength": 100,
          "ory.sh/kratos": {
            "credentials": {
              "password": {
                "identifier": true
              },
              "webauthn": {
                "identifier": true
              },
              "totp": {
                "account_name": true
              }
            }
          }
        },
        "accepted_tos": {
          "type": "boolean",
          "title": "Accept terms and conditions",
          "enum": [
            true
          ]
        }
      },
      "required": [
        "username",
        "accepted_tos"
      ],
      "additionalProperties": false
    }
  }
}

But that leaves various UI issues:

• The checkbox has no "required" indicator, which is a minor.
• The validation message is user unfriendly.
• I can't seem to find a way to add a subtext with links to the actual documents that the user needs to review.
• How do you enforce that even existing members are migrated to this new schema (and request the missing accepted_tos)?
• Can you delete/hide schema entries in the dropdown of the cloud UI? Getting crowded there :)

How would someone go about this with the default UI shipped with Ory Cloud?

[aeneasr]

Sorry, in my initial reply I missed the UI issues!

The JSON Schema does not need an "enum".

{
  "$id": "https://schemas.ory.sh/presets/kratos/identity.username.schema.json",
  "title": "Person",
  "type": "object",
  "properties": {
    "traits": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "title": "Username",
          "maxLength": 100,
          "ory.sh/kratos": {
            "credentials": {
              "password": {
                "identifier": true
              },
              "webauthn": {
                "identifier": true
              },
              "totp": {
                "account_name": true
              }
            }
          }
        },
        "accepted_tos": {
          "const": true,
          "title": "Accept terms and conditions"
        }
      },
      "required": [
        "username",
        "accepted_tos"
      ],
      "additionalProperties": false
    }
  }
}

The checkbox has no "required" indicator, which is a minor.

Thank you, created an issue for it: ory/kratos-selfservice-ui-node#182

The validation message is user unfriendly.

The const workaround should help a bit

I can't seem to find a way to add a subtext with links to the actual documents that the user needs to review.

I see, did you try adding it as HTML to the JSON Schema? We don't support that at the moment for security reasons, but we could think about adding Markdown support to the fields: ory/kratos#2522

How do you enforce that even existing members are migrated to this new schema (and request the missing accepted_tos)?

That is currently a manual process. One option is to:

1. Create a new schema
2. In you app, for every user that has an old schema, update their schema to the new one and send them to the settings screen

Can you delete/hide schema entries in the dropdown of the cloud UI? Getting crowded there :)

Not yet but we have it on the backlog!

[adrianrudnik]

Thank you, that solves most of the issues!

[aeneasr]

My pleasure

[snamber]

Markdown support for titles would be much appreciated! I ran into the same use-case (Terms of Service).