User identity form

Providing user data to the recipe

Unit administrators can set up a user identity form, so that user data that is used frequently across documents only needs to be filled out once.

An example User identity form.

An example User identity form.


Setup

The user identity form is accessed from the left sidebar of the admin site, under Unit management. Each unit has its own unique user identity form, and the setup is only available to unit administrators. In the top left, the admins can select between Profile and Claims screens.

Accessing the User identity form.

Accessing the User identity form.

Profile

To set up the form, the admins can only use form fields and only certain types. No form components are allowed.

 The allowed form field types.

The allowed form field types.

When a user identity form is updated, the users' answers reset and it will have to be filled out again. Fields can be made required, which means that the users won't be able to save their answers to the form unless all answers to required fields are provided.

Usage

The users access the User identity form in the User settings menu in the top right of Create. That's where it's filled out, working just like other forms.

An example User identity form after being filled out by the tester.

An example User identity form after being filled out by the tester.

The user identity data of the creator of the document is provided to the recipe together with other input data. The creator data under the __creator key has two properties: claims and profile. claims contains the data from claims obtained from SSO, while profile contains the saved responses to the user identity form.

Here's an example:

"__creator": {
    "claims": {
      "email": "[email protected]",
      "org_id": "1111aaaa1111aaaa1111aaaa",
      "name": "Jane Doe",
      "identity_type": "User"
    },
    "profile": {
      "Name": "Jane Doe",
      "City": "Copenhagen"
    }
  }