OAuth-токен может отозвать, например чтобы гарантировать выход из аккаунта в вашем приложении. Отозвать токен можете вы и сам магазин.
Чтобы отозвать OAuth-токен, отправьте OAuth-серверу ЮKassa POST-запрос с идентификатором вашего приложения (Client ID), паролем (Client Secret) и токеном, который нужно отозвать.
Идентификатор и пароль приложения можно передать двумя способами: в теле запроса или в заголовке Authorization, закодировав строку
<Идентификатор приложения>:<Пароль приложения>
методом base64 и указав базовый метод авторизации (Basic). Если передать заголовок Authorization, OAuth-сервер проигнорирует идентификатор и пароль в теле запроса.Пример запроса
curl https://yookassa.ru/oauth/v2/revoke_token \ -u <Идентификатор приложения>:<Пароль приложения> \ -d token=<OAuth-токен> \
Описание параметров
| Параметр | Тип | Описание |
|---|---|---|
| token | string | OAuth-токен, который нужно отозвать. Обязательный параметр |
| client_id | string | Идентификатор приложения (Client ID). Обязательный параметр, если не передан заголовок Authorization. Если заголовок передан, параметр игнорируется. |
| client_secret | string | Пароль приложения (Client Secret). Обязательный параметр, если пароль задан в настройках приложения и в запросе не передан заголовок Authorization. Если заголовок передан, параметр игнорируется. |
При успехе в ответ вернется пустое тело ответа.
Пример тела ответа
{}
При неудаче вернется описание возникшей ошибки.
Пример тела ответа с ошибкой
{ "error": "invalid_request", "error_description": "<Описание ошибки>" }
Описание параметров при ответе об ошибке
| Параметр | Тип | Описание |
|---|---|---|
| error | string | Код ошибки. Возможные значения:
Обязательный параметр |
| error_description | string | Описание ошибки Необязательный параметр. |
Владелец магазина может отозвать права для вашего приложения в личном кабинете ЮKassa. В этом случае выданные OAuth-токены перестанут работать. Если вы отправите запрос с отозванным токеном, ЮKassa вернет ошибку.
Есть вопросы или замечания по документации?
Можем созвониться и обсудить их лично: мы поможем вам разобраться, а вы нам — понять, что тут нужно улучшить.
Для этого оставьте свои контакты и выберите время.
Да, хочу обсудить