GetEmployeesByExternalId

Примечание

Вызов метода доступен только администраторам организации.

Возвращает список сотрудников организации по идентификатору учетной записи в системе SSO-провайдера.

GET /GetEmployeesByExternalId

Query Parameters:

• boxId – идентификатор ящика организации в формате GUID.

• externalId – идентификатор учетной записи сотрудника в системе SSO-провайдера.

Request Headers:

• Authorization – данные, необходимые для авторизации.

Status Codes:

• 200 OK – операция успешно завершена.

• 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

• 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

• 402 Payment Required – у указанного ящика закончилась подписка на API.

• 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.

• 404 Not Found – в указанном ящике нет сотрудников с указанным внешним идентификатором.

• 405 Method Not Allowed – используется неподходящий HTTP-метод.

• 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит список сотрудников организации, представленный структурой EmployeeList.

Внешний идентификатор появляется у сотрудника после того, как он зарегистрируется через SSO-провайдера, и возвращается в поле ExternalIdentity структуры Employee. Для организаций, не подключенных к SSO, метод вернет ошибку 404 (Not Found).

Метод может вернуть несколько сотрудников с одним внешним идентификатором.

Примеры использования

Пример HTTP-запроса:

GET /GetEmployeesByExternalId?boxId={{boxId}}&externalId={{externalId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

Пример тела ответа:

{
    "Employees": [
        {
            "User": {
                "UserId": "6dc8c481-7cec-4675-8fd3-711cbe752eaa",
                "Login": "ivanov@example.com",
                "FullName": {
                    "LastName": "Иванов",
                    "FirstName": "Иван",
                    "MiddleName": "Иванович"
                },
                "IsRegistered": true
            },
            "Permissions": {
                "UserDepartmentId": "00000000-0000-0000-0000-000000000000",
                "IsAdministrator": false,
                "DocumentAccessLevel": "DepartmentAndSubdepartments",
                "SelectedDepartmentIds": [],
                "Actions": [
                    { "Name": "CreateDocuments", "IsAllowed": true },
                    { "Name": "DeleteRestoreDocuments", "IsAllowed": true },
                    { "Name": "SignDocuments", "IsAllowed": true },
                    { "Name": "AddResolutions", "IsAllowed": false },
                    { "Name": "RequestResolutions", "IsAllowed": false },
                    { "Name": "ManageCounteragents", "IsAllowed": true }
                ],
                "AuthorizationPermission": {
                    "IsBlocked": false
                }
            },
            "Position": "Бухгалтер",
            "CanBeInvitedForChat": false,
            "CreationTimestamp": {
                "Ticks": 638780603013048865
            },
            "ExternalIdentity": {
                "ExternalId": "ivanov",
                "Email": "ivanov@example.com"
            }
        }
    ],
    "TotalCount": 1
}

---

См. также

Инструкции:

• Работа с сотрудниками

Методы для работы с сотрудниками:

• CreateEmployee — добавляет в организацию сотрудника с указанными реквизитами (доступно только администраторам ящика)

• DeleteEmployee — удаляет сотрудника организации (доступно только администраторам ящика)

• GetEmployee — возвращает данные сотрудника организации по указанному идентификатору (доступно только администраторам ящика)

• GetEmployees — возвращает список сотрудников указанной организации (доступно только администраторам ящика)

• GetEmployeesByExternalId — возвращает список сотрудников организации по идентификатору учетной записи в системе SSO-провайдера (доступно только администраторам ящика)

• GetMyEmployee — возвращает данные сотрудника организации, от имени которого вызывается метод

• GetSubscriptions — возвращает информацию о подписках сотрудника организации на почтовые уведомления

• UpdateEmployee — изменяет данные сотрудника организации (доступно только администраторам ящика)

• UpdateSubscriptions — изменяет подписки сотрудника организации на почтовые уведомления