diff --git a/changelog.d/4-docs/pr-2720 b/changelog.d/4-docs/pr-2720 new file mode 100644 index 0000000000..c84bb55c03 --- /dev/null +++ b/changelog.d/4-docs/pr-2720 @@ -0,0 +1 @@ +Document user deactivation (aka suspension) with SCIM. \ No newline at end of file diff --git a/docs/src/understand/single-sign-on/main.rst b/docs/src/understand/single-sign-on/main.rst index acfe8ff313..e12c4c69a0 100644 --- a/docs/src/understand/single-sign-on/main.rst +++ b/docs/src/understand/single-sign-on/main.rst @@ -546,6 +546,10 @@ For each put request, you need to provide the full json object. All omitted fie -d "$SCIM_USER" \ $WIRE_BACKEND/scim/v2/Users/$STORED_USER_ID +**Deactivate user** + +It is possible to temporarily deactivate an user (and reactivate him later) by setting his ``active`` property to ``true/false`` without affecting his device history. (`active=false` changes the wire user status to `suspended`.) + **Delete user** .. code-block:: bash