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

EmployeeToCreate

На этой странице, помимо EmployeeToCreate, описаны следующие структуры и перечисления:

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

message EmployeeToCreate {
required EmployeeToCreateCredentials Credentials = 1;
optional string Position = 2;
required bool CanBeInvitedForChat = 3;
required EmployeePermissions Permissions = 4;
}
  • Credentials — реквизиты пользователя, представленные структурой EmployeeToCreateCredentials.
  • Position — должность сотрудника.
  • CanBeInvitedForChat — признак того, что нужно отображать сотрудника в списке получателей сообщений в веб-интерфейсе.
  • Permissions — права, которые получит сотрудник, представленные структурой EmployeePermissions.

EmployeeToCreateCredentials

Реквизиты пользователя, который должен стать сотрудником организации.

message EmployeeToCreateCredentials {
optional EmployeeToCreateByLogin Login = 1;
optional EmployeeToCreateByCertificate Certificate = 2;
optional EmployeeToCreateBySsoProvider SsoProvider = 3;
}
  • Login — реквизиты в случае, если сотрудник будет работать по электронной почте и паролю. Представлены структурой EmployeeToCreateByLogin.
  • Certificate — реквизиты в случае, если сотрудник будет работать по сертификату КЭП. Представлены структурой EmployeeToCreateByCertificate.
  • SsoProvider — реквизиты в случае, если сотрудник будет работать по учетной записи SSO. Представлены структурой EmployeeToCreateBySsoProvider.

Должно быть заполнено только одно из этих полей.

EmployeeToCreateByLogin

Реквизиты пользователя, который будет работать по электронной почте и паролю.

message EmployeeToCreateByLogin {
required string Login = 1;
optional FullName FullName = 2;
}
  • Login — логин пользователя. Должен соответствовать формату адреса электронной почты.
  • FullName — фамилия, имя и отчество сотрудника, представленные структурой FullName. Как используется поле, зависит от того, существует ли пользователь с указанным логином:
    • если существует, поле игнорируется: ФИО берутся из его учетной записи;
    • если не существует, метод создаст незарегистрированного сотрудника с этими ФИО.

EmployeeToCreateByCertificate

Реквизиты пользователя, который будет работать по сертификату КЭП.

message EmployeeToCreateByCertificate {
required bytes Content = 1;
optional string AccessBasis = 2;
optional string Email = 3;
}
  • Content — X.509 сертификат пользователя в DER-кодировке.
  • AccessBasis — основание, на котором пользователь имеет доступ к организации. Нужно заполнить в случае, если ИНН сертификата не совпадает с ИНН организации.
  • Email — адрес электронной почты сотрудника. Будет установлен в качестве логина для найденного пользователя без логина или при создании нового пользователя; на него будет отправлено уведомление о добавлении в организацию.

EmployeeToCreateBySsoProvider

Реквизиты пользователя, который будет работать по учетной записи SSO.

message EmployeeToCreateBySsoProvider {
required string Email = 1;
optional FullName FullName = 2;
required string ProviderId = 3;
}
  • Email — адрес электронной почты сотрудника в системе SSO-провайдера. На него будет отправлено приглашение.
  • FullName — фамилия, имя и отчество сотрудника, представленные структурой FullName. Как используется поле, зависит от того, существует ли пользователь с указанным адресом:
    • если существует, поле игнорируется: ФИО берутся из его учетной записи;
    • если не существует, метод создаст незарегистрированного сотрудника с этими ФИО.
  • ProviderId — идентификатор SSO-провайдера, который будет аутентифицировать учетную запись сотрудника. Должен быть настроен для организации, иначе метод вернет ошибку 400 (Bad Request).

См. также

Структура используется:

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

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

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