Перейти к основному содержимому

UpdateEmployee

к сведению

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

Изменяет данные сотрудника организации.

POST /UpdateEmployee

Параметры запроса

  • boxId — идентификатор ящика организации в формате GUID.
  • userId — идентификатор пользователя.

Заголовки запроса

Тело запроса

Тело запроса должно содержать структуру EmployeeToUpdate.

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.
  • 404 — не найден сотрудник с указанным идентификатором.
  • 405 — используется неподходящий HTTP-метод.
  • 409 — нельзя заблокировать последнего незаблокированного администратора ящика или лишить его прав администратора.
  • 415 — тип содержимого запроса не поддерживается.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

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

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

Пример 1

Изменение уровня доступа к документам, списка доступных подразделений и должности.

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

POST /UpdateEmployee?boxid={{boxid}}&userid={{userid}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json

Пример тела запроса:

{
"Permissions": {
"DocumentAccessLevel": {
"DocumentAccessLevel": "SelectedDepartments"
},
"SelectedDepartments": {
"SelectedDepartmentIds": [
"b651ed54-04d8-4ca8-99b5-960fba733147",
]
},
},
"Position": {
"Position": "Главный бухгалтер"
}
}

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

{
"User": {
"UserId": "4b5a02e7-1b9a-4d97-8dc7-1c7eed1ccbfc",
"Login": "email@example.com",
"FullName": {
"LastName": "Иванов",
"FirstName": "Иван",
"MiddleName": "Иванович"
},
"IsRegistered": true
},
"Permissions": {
"UserDepartmentId": "32cb2cd3-ed3a-403a-b220-7dfd59c757db",
"IsAdministrator": false,
"DocumentAccessLevel": "SelectedDepartments",
"SelectedDepartmentIds": [
"b651ed54-04d8-4ca8-99b5-960fba733147",
"32cb2cd3-ed3a-403a-b220-7dfd59c757db"
],
"Actions": [
{
"Name": "CreateDocuments",
"IsAllowed": true
},
{
"Name": "DeleteRestoreDocuments",
"IsAllowed": false
},
{
"Name": "SignDocuments",
"IsAllowed": false
},
{
"Name": "AddResolutions",
"IsAllowed": false
},
{
"Name": "RequestResolutions",
"IsAllowed": true
},
{
"Name": "ManageCounteragents",
"IsAllowed": false
}
],
"AuthorizationPermission": {
"IsBlocked": false
}
},
"Position": "Главный бухгалтер",
"CanBeInvitedForChat": false,
"CreationTimestamp": {
"Ticks": 638781280420601889
}
}

Пример запроса с использованием C# SDK:

var employee = api.UpdateEmployee(
token,
boxId,
userId,
new EmployeeToUpdate
{
Permissions = new EmployeePermissionsPatch
{
DocumentAccessLevel = new EmployeeDocumentAccessLevelPatch
{
DocumentAccessLevel = DocumentAccessLevel.SelectedDepartments
},
SelectedDepartments = new EmployeeSelectedDepartmentsPatch
{
SelectedDepartmentIds =
{
"b651ed54-04d8-4ca8-99b5-960fba733147"
}
}
},
Position = new EmployeePositionPatch
{
Position = "Главный бухгалтер"
}
});

Пример 2

Изменение подразделения, права администрировать организацию, доступных действий и необходимости показывать в списке получателей сообщений.

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

POST /UpdateEmployee?boxid={{boxid}}&userid={{userid}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json

Пример тела запроса:

{
"Permissions": {
"Department": {
"DepartmentId": "11c8276b-815f-4191-adea-c0f884429624"
},
"IsAdministrator": {
"IsAdministrator": true
},
"Actions": [
{ "Name": "ManageCounteragents", "IsAllowed": true },
{ "Name": "SignDocuments", "IsAllowed": false }
]
},
"CanBeInvitedForChat": {
"CanBeInvitedForChat": true
}
}

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

{
"User": {
"UserId": "4b5a02e7-1b9a-4d97-8dc7-1c7eed1ccbfc",
"Login": "email@example.com",
"FullName": {
"LastName": "Иванов",
"FirstName": "Иван",
"MiddleName": "Иванович"
},
"IsRegistered": true
},
"Permissions": {
"UserDepartmentId": "6d710055-9b5d-4bc0-ba2f-9e54adda034e",
"IsAdministrator": true,
"DocumentAccessLevel": "SelectedDepartments",
"SelectedDepartmentIds": [
"b651ed54-04d8-4ca8-99b5-960fba733147",
"6d710055-9b5d-4bc0-ba2f-9e54adda034e"
],
"Actions": [
{
"Name": "CreateDocuments",
"IsAllowed": true
},
{
"Name": "DeleteRestoreDocuments",
"IsAllowed": true
},
{
"Name": "SignDocuments",
"IsAllowed": false
},
{
"Name": "AddResolutions",
"IsAllowed": true
},
{
"Name": "RequestResolutions",
"IsAllowed": true
},
{
"Name": "ManageCounteragents",
"IsAllowed": true
}
],
"AuthorizationPermission": {
"IsBlocked": false
}
},
"Position": "Главный бухгалтер",
"CanBeInvitedForChat": true,
"CreationTimestamp": {
"Ticks": 638781280420601889
}
}

Пример запроса с использованием C# SDK:

var employee = api.UpdateEmployee(
token,
boxId,
userId,
new EmployeeToUpdate
{
Permissions = new EmployeePermissionsPatch
{
Department = new EmployeeDepartmentPatch
{
DepartmentId = "11c8276b-815f-4191-adea-c0f884429624"
},
IsAdministrator = new EmployeeIsAdministratorPatch
{
IsAdministrator = true
},
Actions =
{
new EmployeeAction
{
Name = "ManageCounteragents",
IsAllowed = true
},
new EmployeeAction
{
Name = "SignDocuments",
IsAllowed = false
}
}
},
CanBeInvitedForChat = new EmployeeCanBeInvitedForChatPatch
{
CanBeInvitedForChat = true
}
});

См. также

Инструкции:

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

  • CreateEmployee — добавляет в организацию сотрудника с указанными реквизитами (доступно только администраторам ящика)
  • DeleteEmployee — удаляет сотрудника организации (доступно только администраторам ящика)
  • GetEmployee — возвращает данные сотрудника организации по указанному идентификатору (доступно только администраторам ящика)
  • GetEmployees — возвращает список сотрудников указанной организации (доступно только администраторам ящика)
  • GetEmployeesByExternalId — возвращает список сотрудников организации по идентификатору учетной записи в системе SSO-провайдера (доступно только администраторам ящика)
  • GetMyEmployee — возвращает данные сотрудника организации, от имени которого вызывается метод
  • GetSubscriptions — возвращает информацию о подписках сотрудника организации на почтовые уведомления
  • UpdateEmployee — изменяет данные сотрудника организации (доступно только администраторам ящика)
  • UpdateSubscriptions — изменяет подписки сотрудника организации на почтовые уведомления

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года