Актуальную версию документа см. на сайте Министерства цифрового развития, связи и массовых коммуникаций Российской Федерации по адресу https://digital.gov.ru/ru/documents/6186/.

Б.7.2 Управление приглашениями должностным лицам, зарегистрированным в ЕСИА, на присоединение к учетной записи соответствующей организации

Программный интерфейс ЕСИА позволяет выполнять следующие функции:

- просмотр отправленных, но не принятых приглашений;

- формирование нового приглашения;

- отзыв ранее отправленного приглашения.

Для просмотра отправленных приглашений необходимо сделать запрос на https-адрес программного интерфейса ЕСИА методом GET <49>. Заголовок запроса должен включать в себя маркер доступа. Пример запроса:

--------------------------------

<49> Сервис доступен по URL https://esia-portal1.test.gosuslugi.ru/rs/orgs/{org_oid}/invts

GET /rs/orgs/1000000001/invts HTTP/1.1

Host: esia-portal1.test.gosuslugi.ru

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInNidCI6ImFjY2VzcyIsInR5cCI6IkpXVCIsInZlc

В качестве ответа ЕСИА возвращает перечень приглашений на присоединение к данной организации. Пример ответа:

{

"stateFacts": [

"LastPage",

"Paginated",

"FirstPage"

],

"pageSize": 10,

"pageIndex": 1,

"elements": [

"https://esia-portal1.test.gosuslugi.ru/rs/orgs/1000000001/invts/671621",

"https://esia-portal1.test.gosuslugi.ru/rs/orgs/1000000001/invts/671620",

"https://esia-portal1.test.gosuslugi.ru/rs/orgs/1000000001/invts/671600"

]

}

Для получения данных об отдельном приглашении необходимо выполнить запрос методом GET по адресу с данными конкретного приглашения. Каждое приглашение описывается следующими параметрами:

- <invtId> - идентификатор приглашения;

- <eTag> - тег записи приглашения;

- <email> - адрес, на который было отправлено приглашение;

- <firstName> - имя приглашаемого сотрудника;

- <lastName> - фамилия приглашаемого сотрудника;

- <middleName> - отчество приглашаемого сотрудника (необязательно);

- <snils> - СНИЛС приглашаемого сотрудника (необязательно);

- <status> - статус приглашения (принимает значение "A" (активно) и "I" (инициировано, но не отправлено));

- <createdOn> - дата отправления приглашения;

- <groups> - группа, в которую будет включен пользователь (указывается мнемоника группы) (необязательно).

Пример описания приглашения:

{

"stateFacts": [

"Identifiable"

],

"eTag": "E4EFE25E314136A0EB0DC4EB68DF4B5C185D3E4E",

"invtId": 671600,

"email": "test@mail.ru",

"firstName": "Иван",

"lastName": "Иванов",

"middleName": "Владимирович",

"status": "A",

"createdOn": "23.10.2015",

"groups": [

"ORG_ADMIN"

]

}

Чтобы отправить приглашение, необходимо сделать запрос на https-адрес программного интерфейса ЕСИА методом PUT <50>. Заголовок запроса должен включать в себя маркер доступа, а тело запроса должно включать следующие данные:

--------------------------------

<50> Сервис доступен по URL https://esia-portal1.test.gosuslugi.ru/rs/orgs/{org_oid}/invts

- <email> - адрес, на который отправлять приглашение;

- <firstName> - имя приглашаемого сотрудника;

- <lastName> - фамилия приглашаемого сотрудника;

- <middleName> - отчество приглашаемого сотрудника (необязательно);

- <snils> - СНИЛС приглашаемого сотрудника (необязательно).

Пример запроса (разрывы строки даны для удобства чтения):

PUT /rs/orgs/1000000001/invts HTTP/1.1

Host: esia-portal1.test.gosuslugi.ru

Authorization: Bearer

eyJhbGciOiJSUzI1NiIsInNidCI6ImFjY2VzcyIsInR5cCI6IkpXVCIsInZlciI6MX0eyJleHAiOjE0NDYyMTU2ND

Content-Type: application/json

Cache-Control: no-cache

{

"email": "test@yandex.ru",

"snils": "000-333-333 66",

"firstName": "Михаил",

"lastName": "Иванов",

"middleName": "Иванович"

}

Чтобы удалить приглашение, необходимо сделать запрос на https-адрес программного интерфейса ЕСИА методом DELETE <51>. Заголовок запроса должен включать в себя маркер доступа. Пример запроса:

--------------------------------

<51> Сервис доступен по URL https://esia-portal1.test.gosuslugi.ru/rs/orgs/{org_oid}/invts/{invt_id}

DELETE /rs/orgs/1000000001/invts/671774 HTTP/1.1

Host: esia-portal1.test.gosuslugi.ru

Authorization: Bearer

eyJhbGciOiJSUzI1NiIsInNidCI6ImFjY2VzcyIsInR5cCI6IkpXVCIsInZlciI6MX0eyJleHAiOjE0NDYyMTU2ND

Content-Type: application/json

Cache-Control: no-cache