Merge pull request 'DocSpace removed users' from feature/docspace-rem…

…oved-users into develop

Reviewed-on: https://git.onlyoffice.com/ONLYOFFICE/api.onlyoffice.com/pulls/81

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Change Log
 
+- docspace backend: added the Removed user page
+
 ## 6.3.0
 - docspace oauth api: added a new section
 - docspace api backend: v3.0

site/pages/DocSpace/API Backend/Get Started/How It Works/Long Running Operations/index.md

@@ -1,5 +1,5 @@
 ---
-order: -3
+order: -4
 ---
 
 The user initiates a long-running operation by sending a request to the appropriate API endpoint, which returns an object containing information about the initiated operation. An example of such a request and response:

site/pages/DocSpace/API Backend/Get Started/How It Works/Passing Authentication/index.md

@@ -1,5 +1,5 @@
 ---
-order: -4
+order: -5
 ---
 
 The user needs to perform several easy steps to pass authentication:

site/pages/DocSpace/API Backend/Get Started/How It Works/Removed users/index.md

@@ -0,0 +1,53 @@
+---
+order: -1
+---
+
+Users removed from the DocSpace portal are specified with the `LostUser` constant, which is a `UserInfo` object in the following format:
+
+``` cs
+public static readonly UserInfo LostUser = new()
+{
+    Id = new Guid("{4A515A15-D4D6-4b8e-828E-E0586F18F3A3}"),
+    FirstName = "Unknown",
+    LastName = "Unknown",
+    ActivationStatus = EmployeeActivationStatus.NotActivated
+};
+```
+
+This object is also used for all users not found in the DocSpace portal (guests, users with the pending activation status, etc.).
+
+## Parameters
+
+### Id
+
+The user ID. The removed users always have the `{4A515A15-D4D6-4b8e-828E-E0586F18F3A3}` ID.
+
+Type: string
+
+Value: `new Guid("{4A515A15-D4D6-4b8e-828E-E0586F18F3A3}")`
+
+### FirstName
+
+The user first name.
+
+Type: string
+
+Value: "Unknown"
+
+### LastName
+
+The user last name.
+
+Type: string
+
+Value: "Unknown"
+
+### ActivalionStatus
+
+The user activation status ("NotActivated" or 0).
+
+Type: string | integer
+
+Value: `EmployeeActivationStatus.NotActivated`
+
+For example, when sending GET requests to the `api/2.0/people/email` or `api/2.0/people/{userid}` addresses, the `LostUser` ID is used to check if a user with the specified email or name exists. If the user ID is equal to the `LostUser` ID, this user is removed from the portal and a 404 status code is returned (`User not found`).

site/pages/DocSpace/API Backend/Get Started/How It Works/Uploading Large Files/index.md

@@ -1,5 +1,5 @@
 ---
-order: -2
+order: -3
 ---
 
 In this article, you will learn how to upload large files to DocSpace using our API Backend.

site/pages/DocSpace/API Backend/Get Started/How It Works/Webhooks/index.md

@@ -1,5 +1,5 @@
 ---
-order: -1
+order: -2
 ---
 
 Webhooks are the HTTP/HTTPS callbacks triggered by the events of the API requests, such as POST, PUT, and DELETE. The SSL verification is set when configuring webhooks.

site/pages/DocSpace/API Backend/Get Started/How It Works/index.md

@@ -8,3 +8,4 @@ This page describes what is going on in ONLYOFFICE DocSpace when you work with d
 - [Long-running operations](Long%20Running%20Operations/index.md)
 - [Uploading large files](Uploading%20Large%20Files/index.md)
 - [Webhooks](Webhooks/index.md)
+- [Removed users](Removed%20users/index.md)