Skip to Content

User profiles & attributes

Standard profile fields, custom profile attributes, and visibility.

A user's profile is the set of fields that describe the account. The platform ships with a fixed set of standard fields and lets you extend the profile with your own custom attributes, defined once centrally and assigned to the directories that should use them.

Standard profile fields

Every directory exposes a common set of standard fields. The most important ones are:

FieldNotes
EmailPrimary contact and, in most directories, the login identifier. Can be verified.
UsernameOptional secondary identifier.
Full nameFirst, last, and optionally a middle name.
MobilePhone number, used for SMS factors; can be verified. An optional second number is supported.
Title, Department, Company nameJob attributes. Company name is disabled by default and shares its storage with the value a directory sync delivers.
Office location, employee number, hiring dateAdditional job attributes, available where the directory permits profile editing.

Each directory controls, per field, whether it is enabled, whether it serves as a login identifier, whether it is required, and whether it appears during signup (off / optional / required). At least one identifier must always be active. You configure this on the directory itself — see User directories → Profile schema.

Which system owns a field

Whether a profile field can be edited in the console depends on the directory:

  • Local directories — fields are always editable here. The platform is the source of truth.
  • Synchronized enterprise directories — the upstream Active Directory / LDAP source owns its fields. They are read-only in the console unless upstream sync (write-back) is enabled for that directory, in which case edits you make here are pushed back to the source. With write-back off, the form fields are shown but disabled.

This ties directly to the per-field enabled / required toggles and the directory's upstream-sync setting — see User directories → Synchronization.

For AD/LDAP directories the profile exposes the directory's own identifiers — common name, organizational unit (chosen from an OU picker), and user principal name — in place of free-form email and username editing.

Profile data versus access-bearing data

A profile carries two kinds of data, and the difference decides who may edit a field:

  • Profile data describes the person and changes with their life, not with their access: display name, phone number, preferred language, office location, T-shirt size for the onboarding kit. Where a directory allows self-service, users maintain these fields themselves.
  • Access-bearing data is anything a system reads to decide what the person may do: group membership, roles, account status, cost center or department when an app derives permissions from it, a customer number an application trusts. Such a field is never opened for self-service: a value the user can change is a value the user can grant themselves. Keep it admin-controlled or synchronized from the owning system.

Whether an attribute leaves the platform is decided per application, on the application's Attributes tab: an OIDC application selects the custom attributes it receives as claims, a SAML or WS-Federation application maps them into its attribute statements. Defining an attribute therefore never exposes it by itself. Treat anything that ends up in a token or assertion as operational data: only emit what the receiving app needs, and never expose internal or sensitive values this way.

Custom profile attributes

Note: Custom profile attributes are part of the profile metadata feature, available on the Advanced tier and above (and during the Trial).

When the standard fields are not enough, define a custom attribute. Custom attributes are created once in a central catalog and then assigned to each directory that should collect them. This two-step model keeps a single definition consistent across directories while letting each directory decide whether the field is required and whether it appears at signup.

Defining a custom attribute

Custom attributes are managed under the directories area, on the Attributes page.

  1. Open Attributes and choose to add a new attribute.

  2. Give it a name (the stable identifier) and a label (what users and admins see). Names of the standard profile fields and names of claims used in issued tokens (for example email, title, mobile, groups or sub) are reserved, regardless of casing: a custom attribute with such a name would look like the standard field but hold separate data, so creation is rejected. Pick a distinct name instead, such as jobRole rather than title.

  3. Choose a type:

    TypeUse for
    TextFree-form short text.
    NumberNumeric values.
    DateCalendar dates.
    Select / ChoiceA fixed list of options you define (value and label).
    PasswordA secret value.
  4. Optionally configure:

    • Description: free text shown as a hint below the field, at signup and in the profile, exactly as entered (not translated).
    • Multiple values: allow the field to hold a list.
    • Default value.
    • Uniqueness: by default an attribute's value must be unique across accounts (no two users can share it, for example an employee number). Turn on Allow duplicates to lift that constraint and let several accounts hold the same value.
    • Maintained via API only: the value is displayed but not manually editable, neither in the user's profile nor in the Admin Console; only the management API (an integration or sync) writes it. Such an attribute is also never collected at signup.
  5. Set the visibility (see below) and save.

Every custom attribute can be filtered on through the management API; the index that backs those queries is maintained automatically.

Starting from a template

Templates cover attributes that most tenants need anyway, such as company size, cost center, employment type or hire date. Pick one under Attribute template and the name, type and options are prefilled, together with a label. Nothing stays linked to the template: every value is editable and the result behaves exactly like an attribute you defined from scratch.

Templates also come translated. A label taken from a template is shown to each user in their own language, so a German user reads "Unternehmensgröße" where an English user reads "Company size". After you pick a template, the Label field itself shows the English reference text, because that text is what the translation is looked up from. Leave it as it is to keep the translations.

A label you type yourself is shown to everyone exactly as you entered it, in every language. The same applies to a template label you edit afterwards, so change it only if you prefer your own wording over the translations. Option labels of a select attribute follow the same rule.

Visibility

Visibility controls where the attribute is shown and who can edit it:

VisibilityBehaviour
API onlyNot shown in the profile or the Admin Console. Set through the API, or collected once at signup where a directory asks for it.
Admin ConsoleVisible and editable in the Admin Console, not to the end user.
Admin Console + user profileAdditionally shown to the user in their profile, where they can edit it themselves.

Note: Once an attribute is assigned to any directory, its visibility is locked and the attribute cannot be deleted until it is unassigned everywhere. This protects existing user records and signup/profile rendering from drifting out of sync with the definition.

Assigning to a directory

Any custom attribute can be assigned to a directory, which makes it available on that directory's users. Where the value is set depends on the visibility:

  • an Admin Console + user profile attribute appears in the user's profile and, where enabled, at signup; the user can fill it in;
  • an Admin Console attribute appears on those users in the Admin Console, for you to set; it is not shown to the user;
  • an API only attribute is set through the API and is not shown in the profile or the Admin Console. Use this for a value a relying app consumes (for example a SAML attribute) that is maintained by an integration rather than by a person.

On the directory's attribute configuration you choose, per attribute, whether it appears at signup (optional or required there) and whether it is required in the profile. Signup collection is independent of the visibility: an Admin Console or API only attribute asked for at signup is filled in once by the person registering and afterwards only readable where its visibility allows. Use this for data you need at registration but do not want the user to revisit, such as a referral code or a cost centre. An attribute maintained via API only cannot be collected at signup, since the registrant could never fill its field. The required setting applies where the attribute is shown for editing.

The definition itself is also editable from this tab: Add attribute → Create new attribute creates a new attribute and assigns it to the directory right away, and Edit attribute in a row's actions menu opens the definition dialog (label, type, options, settings). Configure stays the place for the per-directory collection settings described above.

The list order is the display order: signup, the user's profile, and the user detail page show the attributes exactly as arranged here. Drag the handle at the right of a row to reorder.

See also

On this page