User Custom Metadata

In addition to the standard user metadata (such as First Name, Last Name, User ID, and Email Address) that you specify when you add a user, you can manage custom metadata that is unique and meaningful to your business. For example, you can store information about a user's job title, office location, and project teams.

To define your custom metadata fields, you enter a template on the Settings page. Using JSON (JavaScript Object Notation) format, the template can define data types as text fields, password fields, checkboxes, and lists. For instructions on defining the template and entering valid JSON, see Define a Custom Metadata Template.

Add, Edit, and View Custom User Metadata

Once the template is saved in the Admin Portal, the custom metadata fields you defined will display on the Add New User and Edit User pages.

When there is custom metadata specified for a user, it is listed in the Custom Metadata fields on the User's Details page and the New Group and Edit Group pages.

Manage Custom Metadata with API Requests

If you use the Digital.ai App Management API, you can send/receive custom metadata with your API requests/responses. Note that you do not need to define a custom user metadata template for your organization in order to send custom metadata via the API. The request simply needs to include a custom metadata object in the supported JSON data format.

For instructions on specifying custom metadata for a user via the API, see POST /users (to add a new user) and PUT /users/<user_psk> (to edit a user).

For instructions on listing custom metadata for users via the API, see GET /users.