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

Б.13 Сервис получения маркера доступа по идентификационному ключу

Для получения внешней ИС или приложением маркера доступа к API услуг ЕПГУ в обмен на выданный идентификационный ключ (api-key) используется метод REST API ЕСИА GET /orgs/ext-app/{UUID}/tkn.

Примечания:

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

- маркер доступа - маркер доступа, формируемый OAuth2.0 ЕСИА (описание структуры - согласно подразделу "В.5 Сведения о структуре и проверке маркера доступа" настоящего документа) и выдаваемый на скоупы (scope), необходимые и достаточные для доступа к API услуг ЕПГУ (перечень требуемых скоупов указывается службой эксплутации ЕСИА в соответствующей конфигурационной настройке ЕСИА).

Описание метода:

- метод HTTP запроса: GET;

- URL запроса метода: https://<базовый адрес среды ЕСИА>/api/public/v1/orgs/ext-app/{UUID}/tkn

- входные параметры метода:

- - UUID - идентификационный ключ (указывается как in-url);

- - signature - подпись запроса в формате PKCS#7 detached signature в кодировке UTF-8 - подписанный параметр UUID сертификатом организации, на сотрудника которой был выдан (сформирован) идентификационный ключ;

- выходные параметры метода - JSON с параметром "accessTkn" - маркер доступа к API услуг ЕПГУ.

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

GET /esia-rs/api/public/v1/orgs/ext-app/73535141-e8ae-4abb-ae03-

e5d7cd3fbef1/tkn?signature=MIIKeQYJKoZIhvcNAQcCoIIKajCCCmYCAQExDjAMBggqhQMHAQECAgUAMDMGCSqGSIb3

DQEHAaAmBCQ3MzUzNTE0MS1lOGFlLTRhYmItYWUwMy1lNWQ3Y2QzZmJlZjGgggftMIIH6TCCB5agAwIBAgIQYD6SAA2r3oZ

OyLA4syCgLjAKBggqhQMHAQEDAjCCAT8xGDAWBgUqhQNkARINMTAyNzcwMDE5ODc2NzEaMBgGCCqFAwOBAwEBEgwwMDc3MD

cwNDkzODgxCzAJBgNVBAYTAlJVMSkwJwYDVQQIDCA3OCDQodCw0L3QutGCLdCf0LXRgtC10YDQsdGD0YDQszEmMCQGA1UEB

wwd0KHQsNC90LrRgi3Qn9C10YLQtdGA0LHRg9GA0LMxWDBWBgNVBAkMTzE5MTAwMiwg0LMuINCh0LDQvdC60YIt0J%2FQtd

GC0LXRgNCx0YPRgNCzLCDRg9C7LiDQlNC%2B0YHRgtC%2B0LXQstGB0LrQvtCz0L4g0LQuMTUxJjAkBgNVBAoMHdCf0JDQn

iAi0KDQvtGB0YLQtdC70LXQutC%2B0LwiMSUwIwYDVQQDDBzQotC10YHRgtC%2B0LLRi9C5INCj0KYg0KDQotCaMB4XDTE5

MTEyMjA4NDIyOFoXDTIwMTEyMjA4NTIyOFowggGHMTQwMgYJKoZIhvcNAQkBFiV0ZXN0QHRlc3QudGVzdDxtYWlsdG86dGV

zdEB0ZXN0LnRlc3Q%2BMRowGAYIKoUDA4EDAQESDDAwNzcyODEzMTU4NzEWMBQGBSqFA2QDEgs3NjYyNDU2NjAzMzEYMBYG

BSqFA2QBEg0xMTE3Nzk5MDA0MzMzMSEwHwYDVQQMDBjQoNGD0LrQvtCy0L7QtNC40YLQtdC70YwxIDAeBgNVBAoMF9Ce0JD

QniA80KDQvtGB0L3QsNC90L4%2BMRUwEwYDVQQJDAzQnNC%2B0YHQutCy0LAxFTATBgNVBAcMDNCc0L7RgdC60LLQsDEcMB

oGA1UECAwTNzcg0LMuINCc0L7RgdC60LLQsDELMAkGA1UEBhMCUlUxKjAoBgNVBCoMIdCi0LDRgtGM0Y%2FQvdCwINCQ0L3

QtNGA0LXQtdCy0L3QsDEVMBMGA1UEBAwM0KDQvtCz0L7QstCwMSAwHgYDVQQDDBfQntCQ0J4gPNCg0L7RgdC90LDQvdC%2B

PjBmMB8GCCqFAwcBAQEBMBMGByqFAwICJAAGCCqFAwcBAQICA0MABEA7R9s0yPHwRXySk0v0qFZ6NMrPsgIPBzhAIP1ujjZ

upVYpI3UaCGOa6uiy7Scj6DJgiiKI2sHmA7SEFSOvgstqo4IEGTCCBBUwDgYDVR0PAQH%2FBAQDAgTwMB0GA1UdDgQWBBQi

FrhcRjqGP7obev%2FofLFuK85JnzAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwUwYIKwYBBQUHAQEERzBFMEMGC

CsGAQUFBzAChjdodHRwOi8vY2VydGVucm9sbC50ZXN0Lmdvc3VzbHVnaS5ydS9jZHAvdGVzdF9jYV9ydGsuY2VyMB0GA1Ud

IAQWMBQwCAYGKoUDZHEBMAgGBiqFA2RxAjArBgNVHRAEJDAigA8yMDE5MTEyMjA4NDIyN1qBDzIwMjAxMTIyMDg0MjI3WjC

CARAGBSqFA2RwBIIBBTCCAQEMGtCa0YDQuNC%2F0YLQvtCf0YDQviBDU1AgNC4wDB3QmtGA0LjQv9GC0L7Qn9GA0L4g0KPQ

piB2LjIuMAxh0KHQtdGA0YLQuNGE0LjQutCw0YLRiyDRgdC%2B0L7RgtCy0LXRgtGB0YLQstC40Y8g0KTQodCRINCg0L7Rg

dGB0LjQuCDQodCkLzEyNC0zMzgwINC%2B0YIgMTEuMDUuMjAxOAxh0KHQtdGA0YLQuNGE0LjQutCw0YLRiyDRgdC%2B0L7R

gtCy0LXRgtGB0YLQstC40Y8g0KTQodCRINCg0L7RgdGB0LjQuCDQodCkLzEyOC0yOTgzINC%2B0YIgMTguMTEuMjAxNjAlB

gUqhQNkbwQcDBrQmtGA0LjQv9GC0L7Qn9GA0L4gQ1NQIDQuMDBlBgNVHR8EXjBcMFqgWKBWhlRodHRwOi8vY2VydGVucm9s

bC50ZXN0Lmdvc3VzbHVnaS5ydS9jZHAvNDgxMGFmMGY1ZGRjOTkyNDc2ZjdiZjBkZGE0YjdkMGRkOTRjZTFmNy5jcmwwggG

ABgNVHSMEggF3MIIBc4AUSBCvD13cmSR2978N2kt9DdlM4fehggFHpIIBQzCCAT8xGDAWBgUqhQNkARINMTAyNzcwMDE5OD

c2NzEaMBgGCCqFAwOBAwEBEgwwMDc3MDcwNDkzODgxCzAJBgNVBAYTAlJVMSkwJwYDVQQIDCA3OCDQodCw0L3QutGCLdCf0

LXRgtC10YDQsdGD0YDQszEmMCQGA1UEBwwd0KHQsNC90LrRgi3Qn9C10YLQtdGA0LHRg9GA0LMxWDBWBgNVBAkMTzE5MTAw

Miwg0LMuINCh0LDQvdC60YIt0J%2FQtdGC0LXRgNCx0YPRgNCzLCDRg9C7LiDQlNC%2B0YHRgtC%2B0LXQstGB0LrQvtCz0

L4g0LQuMTUxJjAkBgNVBAoMHdCf0JDQniAi0KDQvtGB0YLQtdC70LXQutC%2B0LwiMSUwIwYDVQQDDBzQotC10YHRgtC%2B

0LLRi9C5INCj0KYg0KDQotCaghByCwFWUAAQs%2BgRpGhL66%2F7MAoGCCqFAwcBAQMCA0EAVTneiC0PfzpcScCjesYiqPF

%2FBHrdR2KxZVF8rsbKuEfAzUyA5RZH%2F%2BHnOCaZ618ggut77IFu26wif0RffraxazGCAikwggIlAgEBMIIBVTCCAT8x

GDAWBgUqhQNkARINMTAyNzcwMDE5ODc2NzEaMBgGCCqFAwOBAwEBEgwwMDc3MDcwNDkzODgxCzAJBgNVBAYTAlJVMSkwJwY

DVQQIDCA3OCDQodCw0L3QutGCLdCf0LXRgtC10YDQsdGD0YDQszEmMCQGA1UEBwwd0KHQsNC90LrRgi3Qn9C10YLQtdGA0L

HRg9GA0LMxWDBWBgNVBAkMTzE5MTAwMiwg0LMuINCh0LDQvdC60YIt0J%2FQtdGC0LXRgNCx0YPRgNCzLCDRg9C7LiDQlNC

%2B0YHRgtC%2B0LXQstGB0LrQvtCz0L4g0LQuMTUxJjAkBgNVBAoMHdCf0JDQniAi0KDQvtGB0YLQtdC70LXQutC%2B0Lwi

MSUwIwYDVQQDDBzQotC10YHRgtC%2B0LLRi9C5INCj0KYg0KDQotCaAhBgPpIADavehk7IsDizIKAuMAwGCCqFAwcBAQICB

QCgaTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0yMDA3MTQxMzE5MjRaMC8GCSqGSIb3DQEJ

BDEiBCCHyDksc05aocKt9TfPMAkfINvAAcuRqCqJvS1MVUU1hTAMBggqhQMHAQEBAQUABEBYnLGLx04Y2ot7pxFrGBNEyrO

9XFiUyTLesheld8BHUEzm8VTTW7kuSFMRGmZjz%2B%2FVe86VakA1sY3BSiMe3sHS

Пример ответа на запрос метода:

HTTP/1.1 200 OK

{

"accessTkn":

"eyJ2ZXIiOjEsInR5cCI6IkpXVCIsInNidCI6ImFjY2VzcyIsImFsZyI6IlJTMjU2In0.eyJzY29wZSI6Imh0dHA6XC9cL2

VzaWEuZ29zdXNsdWdpLnJ1XC9vcmdfZnVsP29yZ19vaWQ9MTA3NzEwMTI2NSBodHRwOlwvXC9lc2lhLmdvc3VzbHVnaS5yd

Vwvb3JnX2luZj9vcmdfb2lkPTEwNzcxMDEyNjUiLCJpc3MiOiJodHRwOlwvXC9lc2lhLmdvc3VzbHVnaS5ydVwvIiwidXJu

OmVzaWE6c2lkIjoiNDQ1N2FmNjktZmRhNS00Y2MyLTllYzMtNTE3NzhkYjEyMTA3IiwidXJuOmVzaWE6c2JqX2lkIjoxMDc

3MTE4Mzk2LCJleHAiOjE1OTQ3NDc2NDEsImlhdCI6MTU5NDczNjg0MSwiY2xpZW50X2lkIjoiMTIzNDU2NyJ9.kFQk89VpX

0A3qA6BZu7qqUJf5KnLtmeKaVvt8sn2v73peuIVnYpWL2kmAIKpZAE0vtrvcDSagEBVgXoExdtAkNCAUiGA41HJCJHBbn-

3fFDS3FNHB-9PaC3XclFx8Z04GPX5yt2CnBS_IsTcdvZxOOPuBz4IJYrsMi9R9cFad8Seff0h9OBPt-

kauTpe8gkHvmCVpLkNf5slEeK4rxCMUnBhXSA5RbWbC4yudO9rkhWcPQc-3WwMHrvkVZFRj9YlUe6sf-

fMf3QHn_pk2jcxZFaaMx-EEMPxOoJHy0sOOKzvIElpcWbwkgPCAg4fb5olMg6PUKhE3GThTXbZsJBFng"

}

Перечень возможных возвращаемых ошибок:

Код

Описание

ESIA-005002

Некорректная подпись запроса

(параметр signature некорректного формата или подписанный UUID не соответствует указанному в URL метода параметру UUID)

ESIA-037218

Не найден указанный в запросе идентификационный ключ (UUID)

ESIA-037219

Не найден сотрудник организации, на которого выдан (сформирован) идентификационный ключ (UUID)

ESIA-038000

Не найдена организация, привязанная к идентификационному ключу (UUID)

ESIA-037214

Указанный в запросе идентификационный ключ (UUID) заблокирован

ESIA-037213

У указанного в запросе идентификационного ключа (UUID) истек срок действия

ESIA-037215

Сотрудник организации, выдавший (сформировавший) идентификационный ключ (UUID), заблокирован

ESIA-037216

Сотрудник организации, на которого выдан (сформирован) идентификационный ключ (UUID), заблокирован

ESIA-037217

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

ESIA-005027

В конфигурационной настройке ЕСИА для API услуг ЕПГУ указаны неизвестные скоупы

ESIA-020000

Некорректно указаны параметры запроса метода

Б.12.4 Сервис Rest api прикрепления сотрудников к ЦО Приложение В. Сервисы ЕСИА, основанные на протоколе OAuth 2.0 и OpenID Connect 1.0