diff --git a/source/conf.py b/source/conf.py index 00c90ec596e..82d2cf11b58 100644 --- a/source/conf.py +++ b/source/conf.py @@ -1825,6 +1825,17 @@ def setup(_: Sphinx): "https://docs.mattermost.com/configure/environment-configuration-settings.html#enterprise-search", "configure/enable-copilot.html": "https://docs.mattermost.com/configure/agents-admin-guide.html", +"configure/site-configuration-settings.html#system-properties": + "https://docs.mattermost.com/configure/system-attributes", +"configure/site-configuration-settings.html#before-you-begin": + "https://docs.mattermost.com/manage/admin/user-attributes.html#before-you-begin", +"configure/site-configuration-settings.html#add-properties": + "https://docs.mattermost.com/manage/admin/user-attributes.html#add-attributes", +"configure/site-configuration-settings.html#manage-properties": + "https://docs.mattermost.com/manage/admin/user-attributes.html#manage-attributes", +"configure/site-configuration-settings.html#sync-properties-with-your-identity-provider": + "https://docs.mattermost.com/manage/admin/user-attributes.html#sync-attributes-with-your-identity-provider", + # Deploy redirects "deploy/mobile-apps-faq.html": diff --git a/source/configure/configuration-settings.rst b/source/configure/configuration-settings.rst index 4c4869d79cf..c9b8b11d212 100644 --- a/source/configure/configuration-settings.rst +++ b/source/configure/configuration-settings.rst @@ -20,6 +20,7 @@ System admins for both self-hosted and Cloud Mattermost deployments can manage M Cloud workspace subscription, billing, and account settings Reporting configuration settings User management configuration settings + System attributes Environment configuration settings Site configuration settings Authentication configuration settings @@ -36,6 +37,7 @@ Mattermost configuration settings are organized into the following categories wi - :doc:`Cloud workspace subscription, billing, and account settings` - :doc:`Reporting configuration settings ` - :doc:`User management configuration settings ` +- :doc:`System attributes ` - :doc:`Environment configuration settings ` - :doc:`Site configuration settings ` - :doc:`Authentication configuration settings ` diff --git a/source/configure/site-configuration-settings.rst b/source/configure/site-configuration-settings.rst index 60c26670dad..dd85028843f 100644 --- a/source/configure/site-configuration-settings.rst +++ b/source/configure/site-configuration-settings.rst @@ -7,7 +7,6 @@ Site configuration settings Review and manage the following site configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Site Configuration**: - `Customization <#customization>`__ -- `System Properties <#system-properties>`__ - `Localization <#localization>`__ - `Users and Teams <#users-and-teams>`__ - `Notifications <#notifications>`__ @@ -409,85 +408,6 @@ Enable this configuration setting when there are issues with the mobile app SSO ---- -System properties ------------------ - -.. include:: ../_static/badges/ent-cloud-selfhosted.rst - :start-after: :nosearch: - -From Mattermost v10.8, ensure your teams always have the critical information they need to collaborate effectively by defining and managing organization-specific user profile attributes as system properties that you can synchronize with your AD/LDAP or SAML identity provider. - -System properties enable you to customize user profile properties to match your organization's unique needs and streamline collaboration while keeping user data centralized and consistent. The properties you define, such as position, rank, or location, are :doc:`attributes users can manage as part of their user profile `. These custom profile attributes supplement existing user details visible from the user's profile picture. - -.. image:: ../images/cpa-properties.png - :alt: Mobile examples of a user profile with custom profile attributes added as system properties. - -Before you begin -~~~~~~~~~~~~~~~~~ - -.. tab:: Mattermost Enterprise v10.9 or later - - From Mattermost Enterprise v10.9, you can create and manage system properties as a Mattermost system admin without needing to enable the ``MM_FEATUREFLAGS_CUSTOMPROFILEATTRIBUTES`` feature flag as it's enabled by default. - -.. tab:: Mattermost Enterprise v10.8 - - You'll need Mattermost Enterprise v10.8 or later deployment, and be a Mattermost system admin to enable the system properties feature flag, ``MM_FEATUREFLAGS_CUSTOMPROFILEATTRIBUTES`` to create and manage system properties. See the Mattermost developer documentation for details on `enabling feature flags in a self-hosted deployment `_. Mattermost Cloud customers can request this feature flag be enabled by contacting their Mattermost Account Manager or by `creating a support ticket `_ request. - -In addition, ensure AD/LDAP or SAML synchronization is enabled and configured to synchronize system properties with your AD/LDAP or SAML identity provider. See the :doc:`AD/LDAP groups ` product documentation or :ref:`SAML 2.0 ` configuration settings documentation for details. - -Add properties -~~~~~~~~~~~~~~ - -You can define and manage up to 20 system properties using the System Console by going to **Site Configuration > System Properties**. Each property becomes a user profile attribute users can populate. Once you reach the maximum of 20 properties, you can't create new properties until you `delete properties <#manage-properties>`__ you no longer need. - -1. In the System Console, go to **Site Configuration > System Properties** and select **Add Property**. -2. Enter the following details: - - - **Property name**: Enter a unique name for the property. Property names can be up to 40 characters long. - - **Type**: Specify the type of property as one of the following: - - - **Text** for text-based profile attributes. - - **Phone** for phone number-based profile attributes. - - **URL** for web site address-based profile attributes. - - **Select** for a list of profile attribute values users can choose from. Specify each value followed by pressing TAB or ENTER. Values can be up to 64 characters long, and users can choose a single value. - - **Multi-select** for a list of profile attribute values users can select from. Specify each value followed by pressing TAB or ENTER. Values can be up to 64 characters long, and users can choose multiple values. - -3. Specify the property's visibility as one of the following: - - - **Always show**: The property is always visible in user profiles. - - **Hide when empty**: The property is only visible in user profiles when it has a value. - - **Always hide**: The property is never visible in user profiles. - -4. Save your changes. - -.. tip:: - - Duplicate existing properties by selecting **More** |more-icon| and selecting **Duplicate property**. This creates a new property with the same name and type as the original property. You can then edit the new property to change its name, type, and visibility as needed. - -Manage properties -~~~~~~~~~~~~~~~~~~ - -- **Modify**: Select the property fields to make inline changes to the property's name, type, or values. Select **More** |more-icon| to change a property's visibility. - -- **Order**: Control the order you want properties to appear in user profiles by dragging and dropping them in the list. - -- **Delete**: Delete properties you no longer need or want by selecting **More** |more-icon| and selecting **Delete property**. - -In cases where multiple system admins manage system properties, refresh your web browser instance to see real-time updates to system properties made by other admins. - -Sync properties with your identity provider -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Synchronize a property with AD/LDAP or SAML by selecting **More** |more-icon| and selecting **Link property to AD/LDAP** or **Link property to SAML**. Mattermost takes you directly to the **AD/LDAP** or **SAML 2.0** configuration settings page in the System Console where you can map the attributes you want to synchronize. - -2. Scroll to the **Custom profile attributes sync** section to specify the attribute used to populate the property in user profiles. - -3. Specify the attribute mapping for the property by entering the attribute name in the system property's **Attribute** field. The attribute name must match the attribute name in your identity provider. - -4. Save your changes. - ----- - Localization ------------ diff --git a/source/configure/system-attributes.rst b/source/configure/system-attributes.rst new file mode 100644 index 00000000000..0676c36158a --- /dev/null +++ b/source/configure/system-attributes.rst @@ -0,0 +1,14 @@ +System Attributes +================= + +.. include:: ../_static/badges/ent-cloud-selfhosted.rst + :start-after: :nosearch: + +System attributes configuration settings provide system admins with centralized control over key user account properties. + +Review and manage the following system attributes configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **System Attributes**. + +You can define, manage, and enforce specific attributes, including: + +- **Custom attributes for user profiles**: Display details such as job titles, departments, or other metadata, on user profiles that align with your organizational structures and workflows. Learn more about :doc:`managing custom user profile attributes `. +- **Granular access controls based on user attributes**: Ensure users have access to only the resources and functionality relevant to their roles, bolstering security and compliance across the organization. Learn more about :doc:`managing access based on user attributes `. \ No newline at end of file diff --git a/source/manage/admin/server-configuration.rst b/source/manage/admin/server-configuration.rst index 2a829565c85..4d586bc512c 100644 --- a/source/manage/admin/server-configuration.rst +++ b/source/manage/admin/server-configuration.rst @@ -13,6 +13,7 @@ Whether you’re setting up email notifications, optimizing search capabilities, Store configuration in your database Server configuration options Set up Mattermost Agents + Manage user attributes Environment variables Customize the server SMTP email setup @@ -25,6 +26,7 @@ Whether you’re setting up email notifications, optimizing search capabilities, * :doc:`Store configuration in your database ` - Learn how to store configuration information in your Mattermost database rather than as a JSON file. * :doc:`Server configuration options ` - Learn about server configuration options for Mattermost. * :doc:`Set up Mattermost Agents` - Learn how to enable AI-powered Agents for your Mattermost instance. +* :doc:`Manage custom user attributes ` - Learn how to manage custom user attributes in user profiles in Mattermost. * :doc:`Environment variables ` - Learn how to use environment variables for Mattermost configuration. * :doc:`Customize the server ` - Learn about customizing branding for Mattermost server. * :doc:`SMTP email setup ` - Learn how to set up SMTP email for Mattermost. diff --git a/source/manage/admin/user-attributes.rst b/source/manage/admin/user-attributes.rst new file mode 100644 index 00000000000..7094c8b341f --- /dev/null +++ b/source/manage/admin/user-attributes.rst @@ -0,0 +1,70 @@ +User attributes +======================= + +.. include:: ../../_static/badges/ent-cloud-selfhosted.rst + :start-after: :nosearch: + +From Mattermost v10.8, ensure your teams always have the critical information they need to collaborate effectively by defining and managing organization-specific user profile attributes as system attributes that you can synchronize with your AD/LDAP or SAML identity provider. + +System attributes enable you to customize user profile attributes to match your organization's unique needs and streamline collaboration while keeping user data centralized and consistent. The attributes you define, such as position, rank, or location, are :doc:`attributes users can manage as part of their user profile `. These custom profile attributes supplement existing user details visible from the user's profile picture. + +.. image:: ../../images/cpa-properties.png + :alt: Mobile examples of a user profile with custom user attributes added as system attributes. + +Before you begin +~~~~~~~~~~~~~~~~~ + +You'll need Mattermost Enterprise v10.8 or later deployment, and be a Mattermost system admin to enable the system attributes feature flag, ``MM_FEATUREFLAGS_CUSTOMPROFILEATTRIBUTES`` to create and manage system attributes. See the Mattermost developer documentation for details on `enabling feature flags in a self-hosted deployment `_. Mattermost Cloud customers can request this feature flag be enabled by contacting their Mattermost Account Manager or by `creating a support ticket `_ request. + +In addition, to synchronize system attributes with your AD/LDAP or SAML identity provider, ensure AD/LDAP or SAML synchronization is enabled and configured. See the :doc:`AD/LDAP groups ` product documentation or :ref:`SAML 2.0 ` configuration settings documentation for details. + +Add attributes +~~~~~~~~~~~~~~ + +You can define and manage up to 20 system attributes using the System Console. Each attribute becomes a user profile option users can populate. Once you reach the maximum of 20 attributes, you can't create new attributes until you `delete attributes <#manage-attributes>`__ you no longer need. + +1. In the System Console, go to **Site Configuration > System Attributes > User Attributes** and select **Add Attribute**. +2. Enter the following details: + + - **Attribute name**: Enter a unique name for the attribute. Attribute names can be up to 40 characters long. + - **Type**: Specify the type of attribute as one of the following: + + - **Text** for text-based profile attributes. + - **Phone** for phone number-based profile attributes. + - **URL** for web site address-based profile attributes. + - **Select** for a list of profile attribute values users can choose from. Specify each value followed by pressing **TAB** or **ENTER**. Values can be up to 64 characters long, and users can choose a single value. + - **Multi-select** for a list of profile attribute values users can select from. Specify each value followed by pressing **TAB** or **ENTER**. Values can be up to 64 characters long, and users can choose multiple values. + +3. Specify the attribute's visibility as one of the following: + + - **Always show**: The attribute is always visible in user profiles. + - **Hide when empty**: The attribute is only visible in user profiles when it has a value. + - **Always hide**: The attribute is never visible in user profiles. + +4. Save your changes. + +.. tip:: + + Duplicate existing attributes by selecting **More** |more-icon| and selecting **Duplicate attribute**. This creates a new attribute with the same name and type as the original attribute. You can then edit the new attribute to change its name, type, and visibility as needed. + +Manage attributes +~~~~~~~~~~~~~~~~~~ + +- **Modify**: Select the attribute fields to make inline changes to the attribute's name, type, or values. Select **More** |more-icon| to change a attribute's visibility. + +- **Order**: Control the order you want attributes to appear in user profiles by dragging and dropping them in the list. + +- **Delete**: Delete attributes you no longer need or want by selecting **More** |more-icon| and selecting **Delete property**. + +In cases where multiple system admins manage system attributes, refresh your web browser instance to see real-time updates to system attributes made by other admins. + +Sync attributes with your identity provider +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. Synchronize a attribute with AD/LDAP or SAML by selecting **More** |more-icon| and selecting **Link attribute to AD/LDAP** or **Link attribute to SAML**. Mattermost takes you directly to the **AD/LDAP** or **SAML 2.0** configuration settings page in the System Console where you can map the attributes you want to synchronize. + +2. Scroll to the **Custom profile attributes sync** section to specify the attribute used to populate the attribute in user profiles. + +3. Specify the attribute mapping for the attribute by entering the attribute name in the system attribute's **Attribute** field. The attribute name must match the attribute name in your identity provider. + +4. Save your changes. \ No newline at end of file diff --git a/source/preferences/manage-your-profile.rst b/source/preferences/manage-your-profile.rst index bcc23363cbc..29160c6c003 100644 --- a/source/preferences/manage-your-profile.rst +++ b/source/preferences/manage-your-profile.rst @@ -6,7 +6,7 @@ Manage your Mattermost profile Select your profile picture and select **Profile** to manage the details of your Mattermost profile, including your name, username, nickname, email, and profile picture. -Your Mattermost system admin may :ref:`define additional profile fields ` you can manage. Additionally, some of your profile information may be pulled from another source, which means you won't be able to modify it in Mattermost. Contact your Mattermost system admin for assistance. +Your Mattermost system admin may :doc:`define custom user profile fields ` that you can personalize. Additionally, some of your profile information may be pulled from another source, which means you won't be able to modify it in Mattermost. Contact your Mattermost system admin for assistance. +---------------------+-------------------------------------------------------------------------------------------------+ | **Profile setting** | **Description** |