Метод listUserAccounts
Возвращает список пользователей для указанной федерации.
HTTP-запрос
GET https://iam.api.cloud.yandex.net/iam/v1/saml/federations/{federationId}:listUserAccounts
Path-параметры
Параметр | Описание |
---|---|
federationId | Обязательное поле. Идентификатор федерации для перечисления пользователей. Максимальная длина строки в символах — 50. |
Query-параметры
Параметр | Описание |
---|---|
pageSize | Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
pageToken | Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
Ответ
HTTP Code: 200 - OK
{
"userAccounts": [
{
"id": "string",
// `userAccounts[]` включает только одно из полей `yandexPassportUserAccount`, `samlUserAccount`
"yandexPassportUserAccount": {
"login": "string",
"defaultEmail": "string"
},
"samlUserAccount": {
"federationId": "string",
"nameId": "string",
"attributes": "object"
},
// конец списка возможных полей`userAccounts[]`
}
],
"nextPageToken": "string"
}
Поле | Описание |
---|---|
userAccounts[] | object В настоящее время представляет только аккаунт Яндекс.Паспорта. |
userAccounts[]. id |
string Идентификатор аккаунта пользователя |
userAccounts[]. yandexPassportUserAccount |
object Ресурс YandexPassportUserAccount. userAccounts[] включает только одно из полей yandexPassportUserAccount , samlUserAccount Ресурс YandexPassportUserAccount. Подробнее см. в разделе Аккаунт Яндекс.Паспорта. |
userAccounts[]. yandexPassportUserAccount. login |
string Логин аккаунта Яндекс.Паспорта. |
userAccounts[]. yandexPassportUserAccount. defaultEmail |
string Email используемый по умолчанию для пользователя с аккаунтом Яндекс.Паспорта. |
userAccounts[]. samlUserAccount |
object Пользователь федерации. userAccounts[] включает только одно из полей yandexPassportUserAccount , samlUserAccount Пользователь федерации. Подробнее см. в разделе SAML-совместимые федерации. |
userAccounts[]. samlUserAccount. federationId |
string Обязательное поле. Идентификатор федерации, которой принадлежит пользователь. Максимальная длина строки в символах — 50. |
userAccounts[]. samlUserAccount. nameId |
string Обязательное поле. Идентификатор имени пользоваетля федерации. Идентификатор имени должен быть уникальным в федерации. Длина 1-256 символов. Длина строки в символах должна быть от 1 до 256. |
userAccounts[]. samlUserAccount. attributes |
object Дополнительные атрибуты пользователя. |
nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |