Получить OAuth-токен
Для управления доменами, пользователями и организациями используйте сервис Яндекс 360 для бизнеса.
Запрос позволяет получить OAuth-токен для авторизации пользователя в Яндексе. Токен действует 30 секунд.
Синтаксис запроса
Запрос следует отправлять по протоколу HTTPS с помощью метода POST.
POST /api2/admin/email/get_oauth_token
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
...
domain=<имя домена>
&(login=<email-адрес или логин почтового ящика>|uid=<идентификатор почтового ящика>)
Заголовки:
Параметры:
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
domain | Строка | Имя домена. |
login | Строка | Email-адрес почтового ящика в формате «login@domain.ru» или «login». В запросе нужно передать только один из параметров: |
uid | Число | Идентификатор почтового ящика. Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков. В запросе нужно передать только один из параметров: |
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
domain | Строка | Имя домена. |
login | Строка | Email-адрес почтового ящика в формате «login@domain.ru» или «login». В запросе нужно передать только один из параметров: |
uid | Число | Идентификатор почтового ящика. Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков. В запросе нужно передать только один из параметров: |
Пример запроса
POST /api2/admin/email/get_oauth_token HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&uid=123456789
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&uid=123456789' 'https://pddimp.yandex.ru/api2/admin/email/get_oauth_token'
Структура ответа
{
"domain": "{имя домена}",
"login": "{адрес почтового ящика}",
"oauth-token": "{OAuth-токен}",
"uid": "{идентификатор почтового ящика}",
"success": "{статус выполнения запроса}"
}
{
"domain": "{имя домена}",
"success": "{статус выполнения запроса}",
"error": "{код ошибки}"
}
Название | Тип значения | Описание |
---|---|---|
domain | Строка | Имя домена. |
login | Строка | Email-адрес почтового ящика. |
oauth-token | Строка | OAuth-токен, который следует передать в Яндекс Паспорт для авторизации пользователя. |
uid | Число | Идентификатор почтового ящика. |
success | Строка | Статус выполнения запроса. Возможные значения:
|
error | Строка | Код ошибки. Ключ включается в ответ, если запрос выполнен с ошибкой. Возможные значения:
|
Название | Тип значения | Описание |
---|---|---|
domain | Строка | Имя домена. |
login | Строка | Email-адрес почтового ящика. |
oauth-token | Строка | OAuth-токен, который следует передать в Яндекс Паспорт для авторизации пользователя. |
uid | Число | Идентификатор почтового ящика. |
success | Строка | Статус выполнения запроса. Возможные значения:
|
error | Строка | Код ошибки. Ключ включается в ответ, если запрос выполнен с ошибкой. Возможные значения:
|