Отзыв токена доступа

Обновлено 29 ноября 2024

Компаниям

Холдингам

Платформам

https://fintech.sberbank.ru:9443/ic/sso/api/v2/oauth/revoke

Ресурс /v2/oauth/revoke позволяет отзывать или удалить токен доступа (access_token).

Для откзыва токена доступа (access_token) необходимо отправить POST-запрос /v2/oauth/revoke, в котором передать токен доступа (access_token), Client ID и Client Secret вашей Платформы.

Для обращения к ресурсу необходимо отправлять запрос на:

• Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443/ic/sso/api
• Промышленный контур https://fintech.sberbank.ru:9443/ic/sso/api

Request

/v2/oauth/revoke

• Модель
• Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Content-Type	string	string	^(application/json|text/plain|application/xml|multipart/form-data|application/x-www-form-urlencoded)$	required	Тип данных, которые передаются в теле запроса. Должен содержать значение application/x-www-form-urlencoded.
QUERRY PARAMETERS
client_id	string	string	\d{1,10}	required	Уникальный идентификатор Платформы, полученный при подключении к Sber API. Указывается client_id, для которого выдан токен доступа (access_token), который необходимо отозвать
client_secret	string	string	[a-zA-Z0-9]{8,256}$	required	Пароль вашей Платформы. Вы его впервые получаете при подключении к Sber API и в последующем периодически обновляете. Указывается client_secret, для которого выдан токен доступа (access_token), который необходимо отозвать
token	string	string	^([a-zA-Z0-9]){38}$	required	Значение токена доступа или обновления, который требуется отозвать
token_type_hint	string	string	^(access_token|refresh_token)$	optional	Тип отзываемого токена

POST /ic/sso/api/v2/oauth/revoke?client_id=92233764567396&client_secret=vyYPX12dET&token=xbgKDVrgf756ghi415Wdl012mNKFtEpqr678&token_type_hint=access_token
Content-Type: application/x-www-form-urlencoded

Responses

200 (OK)

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Отсутствует

HTTP/1.1 200 OK

400 (Bad request)

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_client	Client authentication failed. Invalid credentials	В запросе передано неправильное значение client_secret
invalid_grant	Missing parameters: client_secret	Указан неверный Client Secret
invalid_grant	Parameter 'token' is required at request	Указан неверный или совсем не указан access_token

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
{
error	string	required	Ошибка запроса
error_description	string	optional	Описание ошибки
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8

{
    "error": "unsupported_token_type",
    "error_description": ""
}

403 (Forbidden)

errorCode	errorMsg	Описание причины
requestForbidden	The server configuration prohibits executing a request to the endpoint {0}	На данном сервере запрещен вызов указанного ресурса. Например, вызов ресурса /v2/oauth/token осуществляется на домен https://efs-sbbol-ift-web.testsbi.sberbank.ru:9443, а должен осуществляться на домен https://iftfintech.testsbi.sberbank.ru:9443
certificateNotFound	The certificate was not whitelisted for client_id={0}	Не пройдена проверка сертификата по белому списку

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
{
errorCode	string	required	Ошибка запроса
errorMsg	string	required	Описание ошибки
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8

{
   "errorCode": "requestForbidden",
   "errorMsg": "The server configuration prohibits executing a request to the endpoint {0}"
}

415 (Unsupported Media Type)

error	error_description	Описание причины
		Отсутствует параметр Content-type в header запроса
		В параметре Content-type установлено значение, отличное от application/x-www-form-urlencoded

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Отсутствует

HTTP/1.1 415 Unsupported Media Type

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice{
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

json HTTP/1.1 429 Too Many Requests Content-Type: application/json;charset=UTF-8

{ "cause": " TOO_MANY_REQUESTS ", "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61", "message": " Превышен лимит запросов. Повторите операцию позже" }

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}