Sovrain
  1. Documentation
  2. Your organization

How-to guide

Add custom attributes

Define extra fields for your people, such as an employee number or department, fill them in and send them to applications.

This guide adds a field that Sovrain does not have out of the box, for example department or employeeNumber, so that you can store it on each person and send it to applications.

Six attributes always exist and cannot be removed: id, externalId, login, email, firstName and lastName.

Add an attribute

  1. On your home page, under Administration, select Open admin, then select Attributes in the admin menu.
  2. Select Add attribute.
  3. Type the name, for example department, and optionally a description. Select Add.

A name starts with a letter and holds only letters, digits and _, up to 64 characters. It must not repeat an existing name, ignoring upper and lower case. A description holds up to 256 characters and can be edited later in the list.

Fill it in for a person

  1. In the admin menu, select Users and open the person.
  2. Under Attributes, select Edit.
  3. Select + Add attribute, pick the attribute in Key and type the Value.
  4. Select Save.

To fill in many people at once, use the Admin API; see Users in the Admin API.

Send it to applications

An attribute stays inside Sovrain until you map it for an application:

  • for an OpenID Connect app, add a claim on its Claims tab;
  • for a SAML app, add a mapping on its Subject & attributes tab;
  • for SCIM provisioning, add a row on its Attribute mapping tab; the attribute is listed as user_attributes.<name>.

Map claims and attributes shows each of these.

Delete an attribute

  1. On the Attributes page, select × on the attribute’s row.
  2. Sovrain lists what goes with it: the people who have a value and the applications that map it (OpenID Connect ones too, under the heading SAML mappings).
  3. Select Delete attribute, or Cancel.

Deleting removes the values from every person, the SAML mappings that use the attribute, and the OpenID Connect claims mapped from it.

SCIM mappings are not listed and not removed. In every SCIM application that maps the attribute and has Update user attributes on, Sovrain clears the value on every provisioned account after about 3 minutes, without a preview. Remove the row on the application’s Attribute mapping tab first if you want to keep those values there.