Trustbuilder Safe-T
Trustbuilder Safe-T
Breadcrumbs

User Attributes

A user attribute represents either a basic piece of information or a structured set of data related to a user.

The Authorization Engine and Policies rely on these attributes to make context-aware decisions.

This documentation specifically covers user attributes defined in TrustBuilder. It does not cover attributes originating from external sources or received from identity providers (IdPs) during authentication.

A User attribute consists of different elements:

They are two types of attributes:

  • Built-in attributes → they are predefined by TrustBuilder and cannot be edited or deleted. They are always present in every users profile. They are Email, First name, Last name, Username.

  • Custom attributes → they are created and managed by administrators. They can be edited or deleted. They enrich user profiles with organization specific data.

Set up a custom user attribute

In TrustBuilder Admin portal:

  1. Go to Directory > User Attributes.

  2. Click on + Set up user attribute at the top-right corner.

    image-20250613-125257.png

  3. Fill in the fields:

Parameter

Description

Category

Select a category to group the attribute logically. Categories help organize attributes and make them easier to manage and search.

  • common: for general attributes

  • idp: for attributes specifically related to the identity provider used during authentication.

  • SCIM: for SCIM attribute mapping

  • To create a new category enter a new name in the field.

Attribute type
(SCIM only)

Choose the SCIM attribute type:

  • Target SCIM attribute: select a predefined standard attribute from the SCIM User schema.

  • Custom attribute name: define a custom, non-standard attribute to extend the SCIM User schema.
    info A URN will be generated after creation and must be added to the provisioning source.

Attribute name

Enter a variable name. This is a technical identifier used to reference the attribute in code and integrations.

Allowed characters: lowercase letters (a–z), digits (0–9), hyphens (-), and underscores (_).

Display name

Enter the display name of the attribute. It is auto-generated from the variable name but can be modified.

Description

(Optional) Enter a short explanation or note describing the purpose of the attribute.

Data type

Select the format of the attribute value.
⚠️ This cannot be changed once the attribute is created.

  • String: a plain text value

  • Email: a string value that must follow a valid email address format

  • Enumeration: a list of predefined values. Click on + Add new value to define the values.

  • Integer: a numeric value without decimals

  • JSON: a structured JSON object

  • SMS: a phone number

Properties

(Optional) Check one or more settings:

  • Multi-value: the attribute can store multiple values.
    This setting is not compatible with the Email or JSON data types.

  • Unique: the attribute value must be unique across all user profiles.

  • Value required: the attribute must have a value assigned during creation or registration.

  • Case sensitive: the attribute value is sensitive to uppercase and lowercase characters.

Visibility

  • Hidden: the attribute is not visible to users in the self-service portal.

  • Read only: the attribute is visible but cannot be modified by the user in the self-service portal.

  1. Click on Save.

Manage user attributes

Edit a user attribute

To edit a user attribute:

  1. Go to Directory > User Attributes.

  2. Click on an attribute from the list.

  3. Edit attribute properties.
    ⚠️ The data type and some additional settings (Multi-value, Unique and Required) cannot be edited once the attribute is created .

  4. Click Save.

Delete a user attribute

To delete a user attribute:

  1. Go to Directory > User Attributes.

  2. Click on the 3 dots of an attribute.

  3. Click on Delete.

  4. Click on Yes, delete to confirm the action.

    image-20250626-122022.png

The user attribute is successfully deleted.