Token revoke
Обновлено 18 апреля 2023
Ресурс /v2/oauth/revoke
Для отзыва или удаления Acces Token в случае компрометации необходимо использовать ресурс /v2/oauth/revoke.
Модель запроса
| Наименование | Описание |
|---|---|
| Параметры заголовка | |
Content-Type | Обязательный параметр Должен содержать значение application/x-www-form-urlencoded |
| Параметры запроса | |
client_id | Обязательный параметр Указывается идентификатор Приложения Партнера ( client_id), для которого выдан токен, который необходимо отозвать |
client_secret | Обязательный параметр Значение Client Secret Приложения Партнера ( client_id), для которого выдан токен, который необходимо отозвать |
token | Обязательный параметр Значение токена, который требуется отозвать |
token_type_hint | Необязательный параметр Тип отзываемого токена. Может быть указано access_token или refresh_token |
Пример запроса
POST /ic/sso/api/v2/oauth/revoke
Host: edupirfintech.sberbank.ru:9443
Content-Type: application/x-www-form-urlencoded
client_id=40903&client_secret=12345678&token=7749a62e-e2cd-42f5-8e3d-a30912409090-1&token_type_hint=access_token
Модель ответа
В случае успешного выполнения операции в ответ будет возвращен http-code 200 OK.
Коды возрата
| error | error_description | Описание причины |
|---|---|---|
SSOREQUESTED_FORMAT_NOT_ACCEPTABLE_EXCEPTION | В соответствии с текущими настройками сервиса с clientId={0} необходимо запрашивать ответ в формате JSON | Для Приложения Партнера установлен запрет на прием запросов с http-заголовком Accept со значением application/jose |
unsupported_token_type | В параметре token_type_hint указано значение отличное от access_token или refresh_token | |
unauthorized_client | Unknown client_id = '{0}' | Не найдено Приложение Партнера с указанным client_id |
unauthorized_client | Client '{0}' is blocked | Приложение Партнера с указанным client_id заблокировано |
invalid_grant | Указан неверный Client Secret |
Также могут быть получены следующие параметры в ответе при обращении к серверу:
| Параметр | Описание |
|---|---|
errorCode | Код возникшей ошибки |
errorMsg | Описание возникшей ошибки |
Данный тип параметров возвращается, если на сервере возникли следующие исключения:
| http-code | errorCode/errorMsg | Описание причины |
|---|---|---|
| 403 | requestForbidden The server configuration prohibits executing a request to the endpoint {0} | На данном сервере запрещен вызов указанного ресурса. Например, вызов ресурса /v2/oauth/token осуществляется на домен https://sbi.sberbank.ru:9443, а должен осуществляться на домен https://fintech.sberbank.ru:9443 |
| 403 | certificateNotFound The certificate was not whitelisted for client_id={0} | Не пройдена проверка сертификата по белому списку |