ym88659208ym87991671
User-info | Документация для разработчиков

User-info

Обновлено 20 декабря 2023

Ресурс /oauth/user-info

Ресурс /oauth/user-info предназначен для получения детальной информации о Клиенте.

Информация передаваемая в составе user-info согласуется с менеджером при регистрации Приложения Партнера.

Перечень параметров, которые могут быть включены в состав user-info, см. в разделе Область сведений и атрибуты.

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

Схема

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

ПараметрТипОписание
AuthorizationHeaderОбязательный параметр. В параметре передается тип (token_type) и значение (access_token) полученные в ответ на запрос ресурса /oauth/token

Пример запроса

GET/ic/sso/api/v2/oauth/user-info 
Host: https://edupirfintech.sberbank.ru:9443
Authorization: Bearer CD6A56FD-A9C7-4152-AA1D-FA57E550F6AC-1

Параметры ответа

В ответ на запрос будет сформирован JWT токен.

В соответствии со спецификации JSON Web Token (JWT) JWT токен представлен структурой вида:

  • Алгоритм подписи и тип токена (Header);

  • Полезная нагрузка (Payload);

  • Электронная подпись (Signature).

Каждая часть ответа, разделенная точкой должна декодироваться отдельно. Для декодирования User-info следует воспользоваться алгоритмом Base64URL Encoding. Для проверки подписи в поле User-info на стороне клиента, необходимо вычислить подпись публичным ключом Банка, декодировав блок Header и Payload по Base64URL (содержимое между двумя точками). Далее необходимо сравнить полученное значение c блоком Электронная подпись (содержимое после второй точки), декодированным по Base64URL.

Пример ID Token

id_tokenОписание

eyJ0eXAiOiJKV1QiLCJhbGciOiJnb3N0MzQuMT AtMjAxMiJ9.eyJzdWIiOiI1OGMzMzE2ZTBmMDg yYzk1ZjZlZDE1ZGZlNzdmNzZkOTljNjI2ZGVhM mQ4ZTJmZWYyNDcyMzM5Y2QyNzMzNWQzIiwiaXN Db3JwQ2FyZEhvbGRlciI6ZmFsc2UsIm9yZ0twc CI6IjU3NzE0NTg4NCIsImlzcyI6Imh0dHA6Ly9 zYnQtb2Fmcy02Mzg6OTA4MC9pY2RrIiwiT3JnT mFtZSI6ItCe0JDQniBcItCi0LXRgdGCINCh0LH QtdGA0JHQuNC30L3QtdGBIElEXCIiLCJidXlPb kNyZWRpdE1tYiI6ZmFsc2UsImJyYW5jaCI6eyJ uYW1lIjoi0J_Rg9Cx0LvQuNGH0L3QvtC1INCw0 LrRhtC40L7QvdC10YDQvdC-0LUg0L7QsdGJ0LX RgdGC0LLQviBcItCh0LHQtdGA0LHQsNC90Log0 KDQvtGB0YHQuNC4XCIiLCJhZGRyZXNzIjpudWx sLCJjb2RlIjpudWxsfSwib3JnSWQiOjI0NTM0M DMsImluZGl2aWR1YWxFeGVjdXRpdmVBZ2VuY3k iOjEsInVzZXJTaWduYXR1cmVUeXBlIjoi0JXQt NC40L3RgdGC0LLQtdC90L3QsNGPINC_0L7QtNC _0LjRgdGMIiwic3VtbU9mZmVyU21hcnRDcmVka XQiOjAsIm9yZ0xhd0Zvcm1TaG9ydCI6ItCe0JD QniIsIm9yZ0FjdHVhbEFkZHJlc3MiOiIxNDEwM DIsIFJVU1NJQU4gRkVERVJBVElPTiwg0JzQvtG B0LrQvtCy0YHQutCw0Y8g0L7QsdC70LDRgdGC0 YwsINCc0YvRgtC40YnQuNC90YHQutC40LksINC zLtCU0L7Qu9Cz0L7Qv9GA0YPQtNC90YvQuSwg0 YPQuy7QnNC40YDQsCwg0LQuMSwg0LrQsi4zMjU iLCJIYXNoT3JnSWQiOiIzNzgyNTA4ODQ3NDFkM DkyYjE1YmU2YWM4NDM3MmI4YTUxZTk2OTQ3ZGQ 1YTcwMDU1MzRjZmU2M2Q0OTFlNjU4IiwiaXNJZ GVudGlmaWVkIjp0cnVlLCJub25DbGllbnQiOmZ hbHNlLCJkYm9Db250cmFjdHMiOlt7Im51bWJlc iI6IjQwNmMxNThhLTFmOWQtNDBhNC05ZGYxLTJ kY2M5YTQ0MDc5MiIsImRhdGUiOiIyMDIxLTA5L TEwIiwiZmluYW5jZUJsb2NrIjpmYWxzZX1dLCJ oYXNBY3RpdmVDcmVkaXRMaW5lIjpmYWxzZSwiZ W1haWwiOiJhdmFuZ2FyZEBzYmJpZC5ydSIsInJ lc2lkZW50Ijp0cnVlLCJvZmZlckV4cGlyYXRpb 25EYXRlIjoiMjAyMi0wMy0wOVQwOToyNTo1MSs wMzAwIiwib3JnR3VpZCI6ImRjNWM5YTc0LTRjO DctNGY3YS05N2JmLTQ0OGJmN2MwZWEzZiIsIml ubiI6IjAxMDI1NzM4NzUiLCJvcmdKdXJpZGljY WxBZGRyZXNzIjoiMTQxMDAyLCBSVVNTSUFOIEZ FREVSQVRJT04sINCc0L7RgdC60L7QstGB0LrQs NGPINC-0LHQu9Cw0YHRgtGMLCDQnNGL0YLQuNG J0LjQvdGB0LrQuNC5LCDQsy7QlNC-0LvQs9C-0 L_RgNGD0LTQvdGL0LksINGD0Lsu0JzQuNGA0LA sINC0LjEsINC60LIuMzI1IiwiYWN0aXZlIjoxL CJvcmdGdWxsTmFtZSI6ItCe0YLQutGA0YvRgtC -0LUg0LDQutGG0LjQvtC90LXRgNC90L7QtSDQv tCx0YnQtdGB0YLQstC-IFwi0KLQtdGB0YLQvtC y0LDRjyDQvtGA0LPQsNC90LjQt9Cw0YbQuNGPI NCh0LHQtdGA0JHQuNC30L3QtdGBIElEXCIiLCJ 1c2VyR3VpZCI6Ijg3NDJkNWMyLWUwOGMtNGQ1M i04MGIyLWRmMmM1YWY2OTgzMiIsInVzZXJJZCI 6MTY5OTYyOSwib3JnVW5jb25maXJtZWQiOmZhb HNlLCJhdWQiOiI2MzIyOTQiLCJ1c2VyUm9sZXM iOlsiYmFua0NsaWVudCIsInNwZWNpYWxpc3RTd HJ1Y3R1cmFsRGVwb3NpdCJdLCJ1c2VyQ3J5cHR vVHlwZSI6IlNNUyIsInVzZXJHcm91cHMiOiLQo NGD0LrQvtCy0L7QtNC40YLQtdC70YwiLCJzYmJ vbDMiOnRydWUsIm9yZ09ncm4iOiI1MTg2MDY5O DU0MTE5Iiwib2ZmZXJTbWFydENyZWRpdCI6ZmF sc2UsIm5hbWUiOiLQntC90LjQutGB0L7QstGL0 Lkg0JDQstCw0L3Qs9Cw0YDQtCDQkdC-0LTRgNC 40LnRj9GA0L7QstC40YciLCJpbnF1aXJ5T3JkZ XIiOnRydWUsInBob25lX251bWJlciI6Ijc1NTU 1NTU1NTU1Iiwib3JnTGF3Rm9ybSI6ItCe0YLQu tGA0YvRgtC-0LUg0LDQutGG0LjQvtC90LXRgNC 90L7QtSDQvtCx0YnQtdGB0YLQstC-IiwiYWNjb 3VudHMiOlt7ImNvcnJBY2NvdW50TnVtYmVyIjo iMzAxMDE4MTA0MDAwMDAwMDAyMjUiLCJhY2Nvd W50TnVtYmVyIjoiMjY4MTI4MTAzMjUyMTAwMDA xNTYiLCJiaWMiOiIwNDQ1MjUyMjUifSx7ImNvc nJBY2NvdW50TnVtYmVyIjoiMzAxMDE4MTA0MDA wMDAwMDAyMjUiLCJhY2NvdW50TnVtYmVyIjoiO DYxMTI4MTA2MjMwMDA1NDY2NDQiLCJiaWMiOiI wNDQ1MjUyMjUifV19.DPbjqNKZRbu6wdniUQ83 mY8i2Z9Ou3EWyR1VjNqVn5F3Eh_haFP7hOyy-G XJBrKDnnpIJSXw_DH4u1Z3TRFgrA

Заголовок. Алгоритм и тип токена

{ "typ": "JWT", "alg": "gost34.10-2012" }]

Полезная нагрузка

{ "sub": "58c3316e0f082c95f6ed15dfe77f76d99c626dea2d8e2fef2472339cd27335d3", "isCorpCardHolder": false, "orgKpp": "577145884", "iss": "http://sbt-oafs-638:9080/icdk", "OrgName": "ОАО \"Тест СберБизнес ID\"", "buyOnCreditMmb": false, "branch": { "name": "Публичное акционерное общество \"Сбербанк России\"", "address": null, "code": null }, "orgId": 2453403, "individualExecutiveAgency": 1, "userSignatureType": "Единственная подпись", "summOfferSmartCredit": 0, "orgLawFormShort": "ОАО", "orgActualAddress": "141002, RUSSIAN FEDERATION, Московская область, Мытищинский, г.Долгопрудный, ул.Мира, д.1, кв.325", "HashOrgId": "378250884741d092b15be6ac84372b8a51e96947dd5a7005534cfe63d491e658", "isIdentified": true, "nonClient": false, "dboContracts": [ { "number": "406c158a-1f9d-40a4-9df1-2dcc9a440792", "date": "2021-09-10", "financeBlock": false } ], "hasActiveCreditLine": false, "email": "avangard@sbbid.ru", "resident": true, "offerExpirationDate": "2022-03-09T09:25:51+0300", "orgGuid": "dc5c9a74-4c87-4f7a-97bf-448bf7c0ea3f", "inn": "0102573875", "orgJuridicalAddress": "141002, RUSSIAN FEDERATION, Московская область, Мытищинский, г.Долгопрудный, ул.Мира, д.1, кв.325", "active": 1, "orgFullName": "Открытое акционерное общество \"Тестовая организация СберБизнес ID\"", "userGuid": "8742d5c2-e08c-4d52-80b2-df2c5af69832", "userId": 1699629, "orgUnconfirmed": false, "aud": "632294", "userRoles": [ "bankClient", "specialistStructuralDeposit" ], "userCryptoType": "SMS", "userGroups": "Руководитель", "sbbol3": true, "orgOgrn": "5186069854119", "offerSmartCredit": false, "name": "Ониксовый Авангард Бодрийярович", "inquiryOrder": true, "phone_number": "75555555555", "orgLawForm": "Открытое акционерное общество", "accounts": [ { "corrAccountNumber": "30101810400000000225", "accountNumber": "26812810325210000156", "bic": "044525225" }, { "corrAccountNumber": "30101810400000000225", "accountNumber": "86112810623000546644", "bic": "044525225" } ] }

Электронная подпись

<Массив байт электронной подписи>

В user-info включаются обязательные системные и дополнительные атрибуты пользователя для Приложения Партнера.

Обязательные системные атрибуты: sub, iss, aud. Если банку не удается предоставить какие-то данные, то такой атрибут отсутствует в ответе. Проверка электронной подписи (3-я часть ответа) является опциональной и может выполняться Партнером при необходимости проверки неизменности данных user-info.

Коды возврата

В случае возникновения ошибок при вызове ресурса /v2/oauth/token в ответ будут возвращены следующие параметры:

ПараметрОписание
errorКод возникшей ошибки
error_descriptionОписание возникшей ошибки

Перечень исключений:

http-codeerrorerror_descriptionОписание причины
406SSOREQUESTED_FORMAT_NOT_ACCEPTABLE_EXCEPTIONВ соответствии с текущими настройками сервиса с clientId={0} необходимо запрашивать ответ в формате JSONДля Приложения Партнера установлен запрет на прием запросов с http-заголовком Accept со значением application/jose
400invalid_requestMissing authorization headerОтсутствует обязательный параметр заголовка Authorization
400invalid_requestIncorrect authorization methodВ параметре заголовка Authorization указан некорректный тип (должен быть Bearer)
401invalid_tokenAccess Token '<значение полученного токена>' not foundПереданный токен не найден. Например, потому что истек срок его действия или пользователь отозвал согласие на передачу данных

Также могут быть получены следующие параметры в ответе при обращении к серверу:

ПараметрОписание
errorCodeКод возникшей ошибки
errorMsgОписание возникшей ошибки

Данный тип параметров возвращается, если на сервере возникли следующие исключения:

http-codeerrorCode/errorMsgОписание причины
403requestForbidden

The server configuration prohibits executing a request to the endpoint {0}
На данном сервере запрещен вызов указанного ресурса. Например, вызов ресурса /v2/oauth/token осуществляется на домен https://sbi.sberbank.ru:9443, а должен осуществляться на домен https://fintech.sberbank.ru:9443
403certificateNotFound

The certificate was not whitelisted for client_id={0}
Не пройдена проверка сертификата по белому списку
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.