Метод get

HTTP-запрос
Path-параметры
Ответ

Возвращает указанный ресурс UserAccount.

HTTP-запрос

GET https://iam.api.cloud.yandex.net/iam/v1/userAccounts/{userAccountId}

Path-параметры

Параметр	Описание
userAccountId	Обязательное поле. Идентификатор запрашиваемого ресурса UserAccount. Максимальная длина строки в символах — 50.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",

  //  включает только одно из полей `yandexPassportUserAccount`, `samlUserAccount`
  "yandexPassportUserAccount": {
    "login": "string",
    "defaultEmail": "string"
  },
  "samlUserAccount": {
    "federationId": "string",
    "nameId": "string",
    "attributes": "object"
  },
  // конец списка возможных полей

}

В настоящее время представляет только аккаунт Яндекс.Паспорта.

Поле	Описание
id	string Идентификатор аккаунта пользователя
yandexPassportUserAccount	object Ресурс YandexPassportUserAccount. включает только одно из полей `yandexPassportUserAccount`, `samlUserAccount` Ресурс YandexPassportUserAccount. Подробнее см. в разделе Аккаунт Яндекс.Паспорта.
yandexPassportUserAccount. login	string Логин аккаунта Яндекс.Паспорта.
yandexPassportUserAccount. defaultEmail	string Email используемый по умолчанию для пользователя с аккаунтом Яндекс.Паспорта.
samlUserAccount	object Пользователь федерации. включает только одно из полей `yandexPassportUserAccount`, `samlUserAccount` Пользователь федерации. Подробнее см. в разделе SAML-совместимые федерации.
samlUserAccount. federationId	string Обязательное поле. Идентификатор федерации, которой принадлежит пользователь. Максимальная длина строки в символах — 50.
samlUserAccount. nameId	string Обязательное поле. Идентификатор имени пользоваетля федерации. Идентификатор имени должен быть уникальным в федерации. Длина 1-256 символов. Длина строки в символах должна быть от 1 до 256.
samlUserAccount. attributes	object Дополнительные атрибуты пользователя.