Contact UsGet started

SAML Federation API, gRPC: FederationService.ListUserAccounts

Written by
Updated at December 17, 2024

Lists users for the specified federation.

gRPC request

rpc ListUserAccounts (ListFederatedUserAccountsRequest) returns (ListFederatedUserAccountsResponse)

ListFederatedUserAccountsRequest

{
  "federation_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

federation_id

string

Required field. ID of the federation to list user accounts for.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListFederatedUserAccountsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

page_token

string

Page token. To get the next page of results, set page_token
to the ListFederatedUserAccountsResponse.next_page_token
returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The field name. Currently you can use filtering only on the name_id field.
  2. An = operator.
  3. The value in double quotes ("). Must be 1-1000 characters long and match the regular expression
    [a-z0-9A-Z/@_.\-=+*\\]+.

ListFederatedUserAccountsResponse

{
  "user_accounts": [
    {
      "id": "string",
      // Includes only one of the fields `yandex_passport_user_account`, `saml_user_account`
      "yandex_passport_user_account": {
        "login": "string",
        "default_email": "string"
      },
      "saml_user_account": {
        "federation_id": "string",
        "name_id": "string",
        "attributes": "map<string, Attribute>"
      }
      // end of the list of possible fields
    }
  ],
  "next_page_token": "string"
}

Field

Description

user_accounts[]

UserAccount

List of user accounts for the specified federation.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListFederatedUserAccountsRequest.page_size, use the next_page_token as the value
for the ListFederatedUserAccountsRequest.page_token query parameter in the next list request.
Each subsequent list request will have its own next_page_token to continue paging through the results.

UserAccount

Currently represents only Yandex account.

Field

Description

id

string

ID of the user account.

yandex_passport_user_account

YandexPassportUserAccount

A YandexPassportUserAccount resource.

Includes only one of the fields yandex_passport_user_account, saml_user_account.

saml_user_account

SamlUserAccount

A SAML federated user.

Includes only one of the fields yandex_passport_user_account, saml_user_account.

YandexPassportUserAccount

A YandexPassportUserAccount resource.
For more information, see Yandex account.

Field

Description

login

string

Login of the Yandex user account.

default_email

string

Default email of the Yandex user account.

SamlUserAccount

A SAML federated user.
For more information, see federations.

Field

Description

federation_id

string

Required field. ID of the federation that the federation belongs to.

name_id

string

Required field. Name Id of the SAML federated user.
The name is unique within the federation. 1-256 characters long.

attributes

object (map<string, Attribute>)

Additional attributes of the SAML federated user.

Attribute

Field

Description

value[]

string
Previous
DeleteUserAccounts
Next
ListOperations