Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 21 Next »

We are looking at this feature as the first candidate to leverage the new ‘properties’ concept that Joram Wilander has been working on.

Figma Design - Figma Prototype - Loom Demo Video

Ability to define custom profile attributes at the team level

Team admins would be able to define new properties, not old ones at the Team level, and any user that is part of that team will get that property on their profile and would be able to set the value.

Team admins won’t be able to link this property to AD/LDAP at this point.

Here’s how it is displayed.

image-20241031-172727.pngimage-20241031-171547.png

Configuring custom user properties

In the system console, a new view is proposed under Site Configuration > System properties. This will house configuration for customizing properties for users, messages, and cards.

To start, we’ll focus on user properties. Below is the view for configuring these properties.

image-20241001-151011.png

Locked user properties

Every Mattermost server has as set of standard user properties. These properties cannot be removed.

  • Profile Image (no visibility options)

  • Full Name (visibility default: Always show)

  • Username (visibility default: Always show)

  • Email (visibility default: Hide when empty)

  • ID (visibility default: Always hide)

The following configuration can be changed available for standard user properties

  • Visibility - admins can hide/show the property from user profiles (see below)

  • Link/unlink SAML or ADLDAP (if setup)

Unlocked user properties

Default unlocked user properties

By default, the following optional properties ship with user profiles. These properties can be removed or edited as needed. Additional properties can also be added here (see ‘Adding a new property’ below).

  • Nickname

  • Position

Adding a new user property

Users can click the + Add property button to add a new property to the system.

Re-ordering unlocked properties

Each row in the custom properties table can be dragged to re-order. Re-ordering here will change the order properties are displayed in the user profile.

NOTE: Standard properties cannot be re-ordered.

image-20240620-194040.png

Editing a property

Editing property name

Clicking on the property name in the table enables users to edit the name inline.

image-20240620-194304.png

Note: User property names must be unique.

Editing property type

Custom properties can be clicked to open up the types menu to change the property type. This menu is searchable.

image-20240620-194339.png

Editing property options

Admins can set predefined options for a property with Select, and Multi-Select property types. Admins can add and remove options directly in this configuration table.

image-20240620-185913.pngimage-20240620-190149.png

More settings and actions

image-20240620-195649.png

  • Rename: Sets focus on the name cell

  • Edit property type: Sets focus on the type cell and shows the type menu

  • Visibility: Choose whether the property shows in user profiles. Available options are:

    • Always show

    • Always hide

    • Hide when empty (default)

  • Allow new options: Choose whether end users can add new options for the property. This is only available for Select or Multi-Select property types.

  • Duplicate property: Creates a copy of the property with the same configuration and adds to the bottom of the table. Appends ‘2’ to the end of the property name.

  • Link to SAML or AD/LDAP: If SAML or ADLDAP are configured on the server, this option will be available and user properties can be linked.

Linking a property to SAML or AD/LDAP attribute

If the server is already configured with AD/LDAP or SAML sync, then the menu option to link a property becomes available.

image-20240621-191814.png

LDAP and SAML can both be configured on the system and on properties. If so, we will show both options.

image-20240718-145057.png

If “Enable Synchronizing SAML Accounts With AD/LDAP:” is turned on, we will still show both options, but those who are signing in with SAML will have their values inherited from AD/LDAP.

Here’s how the properties would behave depending on the various options turned on.

AD/LDAP SAML Table

AD/LDAP Enabled

SAML Enabled

Enable Synchronizing SAML Accounts With AD/LDAP

User login

Value State

Result

Yes

No

No

Via AD/LDAP

Attribute found in AD/LDAP

Values comes from AD/LDAP

Yes

Yes

No

Via AD/LDAP

Attribute found in AD/LDAP

Values comes from AD/LDAP

Yes

Yes

No

Via SAML

Attribute found in SAML

Value comes from SAML

Yes

Yes

Yes

Via SAML

Attribute found in SAML, and also in AD/LDAP

Value comes from AD/LDAP

Yes

Yes

Yes

Via SAML

Attribute found in SAML, but not in AD/LDAP

Value comes from SAML

Yes

Yes

Yes

Via SAML

Attribute found in SAML, but user as a whole does not exist in AD/LDAP

Value comes from SAML

Yes, but property linked only to SAML

Yes

Yes

Via SAML

If SAML attribute found in LDAP

Value comes from LDAP

Yes, but property linked only to SAML

Yes

Yes

Via SAML

If SAML attribute not found in LDAP

Value comes from SAML

Upon clicking this menu option, a modal opens to link the property with the AD/LDAP or SAML attribute.

image-20240620-194521.png

When a value is entered, the attribute is checked and validated with AD/LDAP (or SAML).

If there’s a way to add validation of attributes when configuring them, but that is additional work.

  • From Colton: It is a valid requirement from customers, as its case sensitive, its very error prone.

image-20240620-200530.png

When a property is linked, it will show ‘Linked with AD/LDAP’ in the row

image-20240620-200630.png

Once a property is linked, it can be edited or unlinked by clicking ‘Edit link to AD/LDAP’ in the menu which will open the modal to make changes.

image-20240621-192118.png

How a linked property appears in the list

A user can also click any of the tags to go to the edit screen for that linkage..

image-20240718-121733.png

If a property is no longer valid and was changed in SAML/LDAP.

We can try to show that property in red, identifying that it was unlinked, and when a person opens up the modal, we can show the error.

image-20240718-132720.png

And clicking on it can open this.

image-20240718-144946.png

Changes to current LDAP/SAML Configuration

Currently various profile attributes are being linked to SAML and LDAP using the various options mentioned on each page.

Various attributes may already be synced on these pages, so we need to ensure that those are migrated once we switch these attributes to the System Properties page.

image-20240717-122536.png

However, since we’ll be having the link option available in the System properties page, we do not need to duplicate these options there.
Thus, we will have a to add anchors to the new page.

Which can be done as follows:

AD/LDAP

image-20240717-150305.png

SAML

Also proposing we encapsulate everything in the SAML section in a white container like we have in AD/LDAP, even if it is just under one and not broken out.

image-20240717-184321.png

Displaying custom properties in the profile popover

Webapp

Standard properties will have reserved slots in the popover, while custom properties will display directly below the ‘Email’ property.

image-20240620-200926.png

image-20240620-200910.png

Mobile

image-20240621-192144.png
image-20240621-192211.png

Custom properties in the profile settings modal

Webapp

image-20240620-201215.pngimage-20240620-201233.png

Mobile

image-20240621-192241.png

  • No labels