Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ Review and manage the following system attributes configuration options in the S

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 </administration-guide/manage/admin/user-attributes>`. API responses for custom profile attributes return default visibility and sort order when those values are missing.
- **User attributes**: 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 user attributes </administration-guide/manage/admin/user-attributes>`. API responses for user attributes return default visibility and sort order when those values are missing.
- **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 </administration-guide/manage/admin/attribute-based-access-control>`.
- **Control user-managed attributes in attribute-based access control (ABAC)**: From Mattermost v10.11 (Enterprise Edition Advanced), user-managed attributes are excluded from ABAC rules by default to prevent unauthorized access. System admins can enable them with a configuration setting. Learn more about enabling user-managed attributes in ABAC rules in the :ref:`User Attributes documentation <administration-guide/manage/admin/user-attributes:before you begin>`.
6 changes: 3 additions & 3 deletions source/administration-guide/manage/admin/user-attributes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ System attributes enable you to customize user profile attributes to match your
From Mattermost v11, you have enhanced control over these user attributes through admin-managed vs user-editable settings. By default, attributes are admin-managed for security, but you can explicitly allow user editing for specific attributes that don't impact access control or sensitive organizational data. These user 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.
:alt: Mobile examples of a user profile with user attributes added as system attributes.

Before you begin
-----------------
Expand Down Expand Up @@ -126,11 +126,11 @@ Manage attributes
- **Delete**: Delete attributes you no longer need or want by selecting **More** |more-icon| and selecting **Delete property**.

.. note::
When updating custom profile attributes via API or automation, the ``attrs`` object replaces existing attribute settings rather than merging. If you send only visibility, the sort order resets to ``0`` unless you include ``sort_order`` in the same request. If a patch fails, the API may return the error string "Unable to patch Custom Profile Attribute field".
When updating user attributes via API or automation, the ``attrs`` object replaces existing attribute settings rather than merging. If you send only visibility, the sort order resets to ``0`` unless you include ``sort_order`` in the same request. If a patch fails, the API may return the error string "Unable to patch User Attribute field".

- **User Edit Permissions**: From Mattermost v11, all user attributes are admin-managed by default for enhanced security. To allow user editing for specific attributes, administrators can enable this through the **More** |more-icon| menu and selecting **Allow user editing**. This should only be enabled for attributes that do not impact security access controls or organizational policies. Attributes used in ABAC policies should remain admin-managed unless there's a specific business need and the security implications are fully understood.

- **Edit User Attribute Values**: From Mattermost v11.1, you can view and update custom profile attribute values for individual users through the System Console. See the :ref:`Manage user attributes <administration-guide/configure/user-management-configuration-settings:manage user attributes>` documentation for details.
- **Edit User Attribute Values**: From Mattermost v11.1, you can view and update user attribute values for individual users through the System Console. See the :ref:`Manage user attributes <administration-guide/configure/user-management-configuration-settings:manage user attributes>` documentation for details.

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.

Expand Down
22 changes: 11 additions & 11 deletions source/administration-guide/manage/mmctl-command-line-tool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ mmctl commands
- `mmctl bot`_ - Bot Management
- `mmctl channel`_ - Channel Management
- `mmctl command`_ - Command Management
- `mmctl cpa`_ - Custom Profile Attribute Management
- `mmctl cpa`_ - User Attribute Management
- `mmctl completion`_ - Generate autocompletion scripts for bash, fish, powershell, and zsh
- `mmctl compliance-export`_ - Compliance Export Management
- `mmctl config`_ - Configuration Management
Expand Down Expand Up @@ -2013,7 +2013,7 @@ mmctl cpa
Manage User Attributes for extended user profile information.

Child Commands
- `mmctl cpa field`_ - Manage CPA fields
- `mmctl cpa field`_ - Manage User Attribute fields

**Options**

Expand All @@ -2026,13 +2026,13 @@ mmctl cpa field

**Description**

Manage Custom Profile Attribute fields.
Manage User Attribute fields.

Child Commands
- `mmctl cpa field create`_ - Create a new CPA field
- `mmctl cpa field delete`_ - Delete a CPA field
- `mmctl cpa field edit`_ - Edit a CPA field
- `mmctl cpa field list`_ - List CPA fields
- `mmctl cpa field create`_ - Create a new User Attribute field
- `mmctl cpa field delete`_ - Delete a User Attribute field
- `mmctl cpa field edit`_ - Edit a User Attribute field
- `mmctl cpa field list`_ - List User Attribute fields

**Options**

Expand All @@ -2045,7 +2045,7 @@ mmctl cpa field create

**Description**

Create a new Custom Profile Attribute field.
Create a new User Attribute field.

**Format**

Expand Down Expand Up @@ -2088,7 +2088,7 @@ mmctl cpa field delete

**Description**

Delete an existing Custom Profile Attribute field.
Delete an existing User Attribute field.

**Format**

Expand Down Expand Up @@ -2129,7 +2129,7 @@ mmctl cpa field edit

**Description**

Edit an existing Custom Profile Attribute field.
Edit an existing User Attribute field.

**Format**

Expand Down Expand Up @@ -2174,7 +2174,7 @@ mmctl cpa field list

**Description**

List all Custom Profile Attribute fields.
List all User Attribute fields.

**Format**

Expand Down
Loading