OAuth-авторизация Яндекс Паспорта

Внимание. Сервис Яндекс Почта для домена больше не поддерживается. API Почты для домена прекратит работу с 1 апреля 2023 года. С 24 марта доступность сервиса будет ограничена.

Для управления доменами, пользователями и организациями используйте сервис Яндекс 360 для бизнеса.

Документация API 360

Запрос проверяет переданный OAuth-токен и авторизует пользователя в Яндекс Почте, если токен валидный.

Синтаксис запроса

Запрос следует отправлять по протоколу HTTPS с помощью метода GET.

https://passport.yandex.ru/passport?
mode=oauth
& access_token=<OAuth-токен>
& type=trusted-pdd-partner
& retpath=<URL>
Параметр Тип Значение
Обязательные
mode Строка

Вызываемый режим Яндекс Паспорта.

Для OAuth-авторизации необходимо присвоить значение «oauth».

access_token Строка

OAuth-токен, полученный в ответе на запрос Получить OAuth-токен.

type Строка

Тип сервиса, отправляющего запрос.

Необходимо присвоить значение «trusted-pdd-partner».

Необязательные
retpath Строка

URL, на который Паспорт перенаправит пользователя после успешной авторизации. Это может быть URL любого сервиса Яндекса.

Если параметр не указан, Паспорт перенаправит пользователя на Яндекс Почту.

URL должен быть закодирован в URL Encode.

Параметр Тип Значение
Обязательные
mode Строка

Вызываемый режим Яндекс Паспорта.

Для OAuth-авторизации необходимо присвоить значение «oauth».

access_token Строка

OAuth-токен, полученный в ответе на запрос Получить OAuth-токен.

type Строка

Тип сервиса, отправляющего запрос.

Необходимо присвоить значение «trusted-pdd-partner».

Необязательные
retpath Строка

URL, на который Паспорт перенаправит пользователя после успешной авторизации. Это может быть URL любого сервиса Яндекса.

Если параметр не указан, Паспорт перенаправит пользователя на Яндекс Почту.

URL должен быть закодирован в URL Encode.