diff --git a/source/configure/deprecated-configuration-settings.rst b/source/configure/deprecated-configuration-settings.rst index 71f06c1bd3c..da80e2d987a 100644 --- a/source/configure/deprecated-configuration-settings.rst +++ b/source/configure/deprecated-configuration-settings.rst @@ -807,48 +807,6 @@ The file must be in the same directory as your ``config.json`` file if you set a ---- -Experimental API endpoint settings ----------------------------------- - -Enable API team deletion -~~~~~~~~~~~~~~~~~~~~~~~~ - -*Removed in Mattermost v10 (Sept 2024) release* - -This setting isn't available in the System Console and can only be set in ``config.json``. - -**False**: The API endpoint cannot be called. Note that ``api/v4/teams/{teamid}`` can still be used to soft delete a team. - -+-------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableAPITeamDeletion": false``. | -+-------------------------------------------------------------------------------+ - -Enable API user deletion -~~~~~~~~~~~~~~~~~~~~~~~~ - -*Removed in Mattermost v10 (Sept 2024) release* - -This setting isn't available in the System Console and can only be set in ``config.json``. - -**False**: The API endpoint cannot be called. Note that ``api/v4/users/{userid}`` can still be used to soft delete a user. - -+-------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableAPIUserDeletion": false``. | -+-------------------------------------------------------------------------------+ - -Enable API channel deletion -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -*Removed in Mattermost v10 (Sept 2024) release* - -This setting isn't available in the System Console and can only be set in ``config.json``. - -**False**: The API endpoint cannot be called. Note that ``api/v4/channels/{channelid}`` can still be used to soft delete a channel. - -+----------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``"EnableAPIChannelDeletion": false``. | -+----------------------------------------------------------------------------------+ - Other deprecated settings -------------------------- diff --git a/source/configure/environment-configuration-settings.rst b/source/configure/environment-configuration-settings.rst index 3a5e2e9cb16..3dd3a397696 100644 --- a/source/configure/environment-configuration-settings.rst +++ b/source/configure/environment-configuration-settings.rst @@ -182,4 +182,70 @@ Disable Customer Portal requests | restricted deployment environments. | | +-----------------------------------------------+---------------------------------------------------------------------------+ | **Note**: Cloud admins can’t modify this configuration setting. | -+-----------------------------------------------+---------------------------------------------------------------------------+ \ No newline at end of file ++-----------------------------------------------+---------------------------------------------------------------------------+ + +.. config:setting:: exp-enableapiteamdeletion + :displayname: Enable API team deletion (ServiceSettings) + :systemconsole: N/A + :configjson: EnableAPITeamDeletion + :environment: N/A + + - **true**: The ``api/v4/teams/{teamid}?permanent=true`` API endpoint can be called by team admins and system admins (or users with appropriate permissions), or by running the mmctl team delete command, to permanently delete a team. + - **false**: **(Default)** The API endpoint cannot be called, but ``api/v4/teams/{teamid}`` can still be used to soft delete a team. + +Enable API team deletion +~~~~~~~~~~~~~~~~~~~~~~~~ + +This setting isn't available in the System Console and can only be set in ``config.json``. + +**True**: The ``api/v4/teams/{teamid}?permanent=true`` API endpoint can be called by team admins and system admins (or users with appropriate permissions), or by running the :ref:`mmctl team delete ` command to permanently delete a team. + +**False**: The API endpoint cannot be called. Note that ``api/v4/teams/{teamid}`` can still be used to soft delete a team. + ++-------------------------------------------------------------------------------------------------------------------+ +| This feature's ``config.json`` setting is ``"EnableAPITeamDeletion": false`` with options ``true`` and ``false``. | ++-------------------------------------------------------------------------------------------------------------------+ + +.. config:setting:: exp-enableapiuserdeletion + :displayname: Enable API user deletion (ServiceSettings) + :systemconsole: N/A + :configjson: EnableAPIUserDeletion + :environment: N/A + + - **true**: The ``api/v4/users/{userid}?permanent=true`` API endpoint can be called by system admins (or users with appropriate permissions), or by running the mmctl user delete command, to permanently delete a user. + - **false**: **(Default)** The API endpoint cannot be called, but ``api/v4/users/{userid}`` can still be used to soft delete a user. + +Enable API user deletion +~~~~~~~~~~~~~~~~~~~~~~~~ + +This setting isn't available in the System Console and can only be set in ``config.json``. + +**True**: The ``api/v4/users/{userid}?permanent=true`` API endpoint can be called by system admins (or users with appropriate permissions), or by running the :ref:`mmctl user delete ` command, to permanently delete a user. + +**False**: The API endpoint cannot be called. Note that ``api/v4/users/{userid}`` can still be used to soft delete a user. + ++-------------------------------------------------------------------------------------------------------------------+ +| This feature's ``config.json`` setting is ``"EnableAPIUserDeletion": false`` with options ``true`` and ``false``. | ++-------------------------------------------------------------------------------------------------------------------+ + +.. config:setting:: exp-enableapichanneldeletion + :displayname: Enable API channel deletion (ServiceSettings) + :systemconsole: N/A + :configjson: EnableAPIChannelDeletion + :environment: N/A + + - **true**: The ``api/v4/channels/{channelid}?permanent=true`` API endpoint can be called by system admins (or users with appropriate permissions), or by running the mmctl channel delete command, to permanently delete a channel. + - **false**: **(Default)** The API endpoint cannot be called, but ``api/v4/channels/{channelid}`` can still be used to soft delete a channel. + +Enable API channel deletion +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This setting isn't available in the System Console and can only be set in ``config.json``. + +**True**: The ``api/v4/channels/{channelid}?permanent=true`` API endpoint can be called by system admins (or users with appropriate permissions), or by running the :ref:`mmctl channel delete ` command, to permanently delete a channel. + +**False**: The API endpoint cannot be called. Note that ``api/v4/channels/{channelid}`` can still be used to soft delete a channel. + ++----------------------------------------------------------------------------------------------------------------------+ +| This feature's ``config.json`` setting is ``"EnableAPIChannelDeletion": false`` with options ``true`` and ``false``. | ++----------------------------------------------------------------------------------------------------------------------+ \ No newline at end of file diff --git a/source/manage/mmctl-command-line-tool.rst b/source/manage/mmctl-command-line-tool.rst index 3fccaa0cce8..d16a2fb9799 100644 --- a/source/manage/mmctl-command-line-tool.rst +++ b/source/manage/mmctl-command-line-tool.rst @@ -943,6 +943,9 @@ mmctl channel delete Permanently delete channels along with all related information including posts from the database. +.. note:: + Requires the :ref:`Enable API Channel Deletion ` configuration setting to be set to ``true``. If this configuration setting is set to ``false``, attempting to delete the channel using mmctl fails. + **Format** .. code-block:: sh @@ -5465,6 +5468,9 @@ mmctl team delete Permanently delete a team along with all related information including posts from the database. +.. note:: + Requires the :ref:`Enable API Team Deletion ` configuration setting to be set to ``true``. If this configuration setting is set to ``false``, attempting to delete the team using mmctl fails. + **Format** .. code-block:: sh @@ -6218,6 +6224,9 @@ mmctl user delete Permanently delete users along with all related information including posts from the database. +.. note:: + Requires the :ref:`Enable API User Deletion ` configuration setting to be set to ``true``. If this configuration setting is set to ``false``, attempting to delete the user using mmctl fails. + **Format** .. code-block:: sh