Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
© 2022 Yandex.Cloud LLC
Yandex Cloud Organization
  • Getting started
  • Managing organizations
    • Creating an organization
    • Editing organization data
    • Switching to another organization
  • Managing users
    • Overview
    • Add a user
    • Get the user's ID or email
    • Assigning access rights
    • Deleting a user account
  • Managing identity federations
    • Configuring an identity federation
    • Authentication using Active Directory
    • Authentication using Google Workspace
    • Authentication using Azure Active Directory
    • Authentication using Keycloak
    • Authentication using an SAML-compatible identity federation
  • Managing clouds and services
  • API reference
    • Authentication
    • gRPC
      • Overview
      • GroupService
      • OrganizationService
      • UserService
      • CertificateService
      • FederationService
      • OperationService
    • REST
      • Overview
      • Group
        • Overview
        • create
        • delete
        • get
        • list
        • listAccessBindings
        • listMembers
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
        • updateMembers
      • Organization
        • Overview
        • get
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
      • User
        • Overview
        • deleteMembership
        • listMembers
      • Federation
        • Overview
        • list
        • get
        • listUserAccounts
        • delete
        • addUserAccounts
        • update
        • listOperations
        • create
      • Certificate
        • Overview
        • list
        • get
        • delete
        • update
        • listOperations
        • create
  • Pricing policy
  1. API reference
  2. REST
  3. Federation
  4. listUserAccounts

Method listUserAccounts

Written by
Yandex Cloud
  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Lists users for the specified federation.

HTTP request

GET https://organization-manager.api.cloud.yandex.net/organization-manager/v1/saml/federations/{federationId}:listUserAccounts

Path parameters

Parameter Description
federationId Required. ID of the federation to list user accounts for. The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "userAccounts": [
    {
      "id": "string",

      // `userAccounts[]` includes only one of the fields `yandexPassportUserAccount`, `samlUserAccount`
      "yandexPassportUserAccount": {
        "login": "string",
        "defaultEmail": "string"
      },
      "samlUserAccount": {
        "federationId": "string",
        "nameId": "string",
        "attributes": "object"
      },
      // end of the list of possible fields`userAccounts[]`

    }
  ],
  "nextPageToken": "string"
}
Field Description
userAccounts[] object

Currently represents only Yandex account.

userAccounts[].
id
string

ID of the user account.

userAccounts[].
yandexPassportUserAccount
object
A YandexPassportUserAccount resource.
userAccounts[] includes only one of the fields yandexPassportUserAccount, samlUserAccount

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

userAccounts[].
yandexPassportUserAccount.
login
string

Login of the Yandex user account.

userAccounts[].
yandexPassportUserAccount.
defaultEmail
string

Default email of the Yandex user account.

userAccounts[].
samlUserAccount
object
A SAML federated user.
userAccounts[] includes only one of the fields yandexPassportUserAccount, samlUserAccount

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

userAccounts[].
samlUserAccount.
federationId
string

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

The maximum string length in characters is 50.

userAccounts[].
samlUserAccount.
nameId
string

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

The string length in characters must be 1-256.

userAccounts[].
samlUserAccount.
attributes
object

Additional attributes of the SAML federated user.

nextPageToken string

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

Was the article helpful?

Language / Region
© 2022 Yandex.Cloud LLC
In this article:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response