How do you configure `metadata public` for an identity schem Ory Community #ory-network

How do you configure `metadata_public` for an iden...

flat-flower-81031

01/20/2023, 3:47 PM

How do you configure

metadata_public

for an identity schema? I thought I had done it correctly, but the Managed UI is showing an extra field now (with no label) for my metadata property. The docs say the metadata isn’t validated, so do you just not include it in the identity schema?

flat-flower-81031

01/20/2023, 3:47 PM

Here is my schema:

Copy code

{
  "$id": "<https://exammple.com/ory/identity.schema.json>",
  "title": "Example User",
  "type": "object",
  "properties": {
    "traits": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string",
          "format": "email",
          "title": "Email",
          "<http://ory.sh/kratos|ory.sh/kratos>": {
            "credentials": {
              "password": {
                "identifier": true
              },
              "webauthn": {
                "identifier": true
              },
              "totp": {
                "account_name": true
              }
            },
            "recovery": {
              "via": "email"
            },
            "verification": {
              "via": "email"
            }
          },
          "maxLength": 320
        },
        "name": {
          "type": "object",
          "properties": {
            "first": {
              "type": "string",
              "title": "First name",
              "maxLength": 256
            },
            "last": {
              "type": "string",
              "title": "Last name",
              "maxLength": 256
            }
          }
        }
      },
      "required": [
        "email"
      ],
      "additionalProperties": false
    },
    "metadata_public": {
      "type": "object",
      "properties": {
        "bonfireUserId": {
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  }
}

magnificent-energy-493

01/20/2023, 3:51 PM

like so for example

Copy code

"metadata_public": {
      "type": "object",
      "properties": {
        "lang": {
          "type": "string",
          "title": "Preferred Language"
        }
      }
    }

magnificent-energy-493

01/20/2023, 3:55 PM

Copy code

"metadata_public": {
      "type": "object",
      "properties": {
        "bonfireUserId": {
          "type": "string",
          "title": "bonfireUserId"
        }
      }
    }

steep-lamp-91158

01/20/2023, 3:57 PM

yes, there is (currently) no point in including it in the schema as it is basically ignored

steep-lamp-91158

01/20/2023, 3:58 PM

flat-flower-81031

01/20/2023, 5:03 PM

Thanks @steep-lamp-91158. I guess I’ll just remove it from the schema. You may want to update the docs to be more clear about not including it. https://github.com/ory/kratos/issues/2513 sort of covers the fields showing in the UI, but talks more about validation. I don’t mind that the values aren’t validated at this time. But it is nice to have the metadata in the schema so all team members are aware of what the metadata should look like.

steep-lamp-91158

01/20/2023, 5:17 PM

Ideally metadata would behave the same as traits, but not show up in the UI

💯 1

flat-flower-81031

01/20/2023, 5:18 PM

Yes. Long-term that would be ideal.

10 Views

Open in Slack

Previous Next