Identity and Access Management SAML API, REST: Federation.ListUserAccounts
Lists users for the specified federation.
HTTP request
GET https://iam.api.cloud.yandex.net/iam/v1/saml/federations/{federationId}:listUserAccounts
Path parameters
|
Field |
Description |
|
federationId |
string Required field. ID of the federation to list user accounts for. |
Query parameters
|
Field |
Description |
|
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
|
pageToken |
string Page token. To get the next page of results, set |
Response
HTTP Code: 200 - OK
{
"userAccounts": [
{
"id": "string",
// Includes only one of the fields `yandexPassportUserAccount`, `samlUserAccount`
"yandexPassportUserAccount": {
"login": "string",
"defaultEmail": "string"
},
"samlUserAccount": {
"federationId": "string",
"nameId": "string",
"attributes": {
"value": [
"string"
]
}
}
// end of the list of possible fields
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
userAccounts[] |
List of user accounts for the specified federation. |
|
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
UserAccount
Currently represents only Yandex account.
|
Field |
Description |
|
id |
string ID of the user account. |
|
yandexPassportUserAccount |
A YandexPassportUserAccount resource. Includes only one of the fields |
|
samlUserAccount |
A SAML federated user. Includes only one of the fields |
YandexPassportUserAccount
A YandexPassportUserAccount resource.
For more information, see Yandex account.
|
Field |
Description |
|
login |
string Login of the Yandex user account. |
|
defaultEmail |
string Default email of the Yandex user account. |
SamlUserAccount
A SAML federated user.
For more information, see federations.
|
Field |
Description |
|
federationId |
string Required field. ID of the federation that the federation belongs to. |
|
nameId |
string Required field. Name Id of the SAML federated user. |
|
attributes |
Additional attributes of the SAML federated user. |
Attribute
|
Field |
Description |
|
value[] |
string |