Подключиться
Yandex Identity and Access Management

FederationService

Набор методов для управления федерациями.

Вызов Описание
Get Возвращает указанную федерацию.
List Возвращает список федераций в указанном каталоге.
Create Создает федерацию в указанном каталоге.
Update Изменяет указанную федерацию.
Delete Удаляет указанную федерацию.
AddUserAccounts Добавляет пользователей в указанную федерацию.
ListUserAccounts Возвращает список пользователей для указанной федерации.
ListOperations Возвращает список операций для указанной федерации.

Вызовы FederationService

Get

Возвращает указанную федерацию.
Чтобы получить список доступных федераций, используйте запрос List.

rpc Get (GetFederationRequest) returns (Federation)

GetFederationRequest

Поле Описание
federation_id string
Идентификатор возвращаемой федерации. Чтобы получить идентификатор федерации, используйте запрос FederationService.List. Максимальная длина строки в символах — 50.

Federation

Поле Описание
id string
Обязательное поле. Идентификатор федерации. Максимальная длина строки в символах — 50.
folder_id string
Обязательное поле. Идентификатор каталога, которому принадлежит федерация. Максимальная длина строки в символах — 50.
name string
Обязательное поле. Имя федерации. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание федерации. Максимальная длина строки в символах — 256.
created_at google.protobuf.Timestamp
Время создания.
cookie_max_age google.protobuf.Duration
Время жизни файлов cookie в браузере в секундах. Если время жизни cookie не истекло, то консоль управления сразу аутентифицирует пользователя и отправляет на главную страницу. Допустимые значения — от 10m до 12h включительно.
auto_create_account_on_login bool
Добавлять новых пользователей автоматически при успешной аутентификации. Пользователям будет назначена роль resource-manager.clouds.member автоматически, но остальные роли надо будет назначить самостоятельно.
Если значение false, то пользователь, которого не добавили в облако, не сможет войти, даже если пройдет аутентификацию на вашем сервере.
issuer string
Обязательное поле. Идентификатор IdP-сервера, который будет использоваться для аутентификации. Этот же идентификатор сервер IdP указывает в ответе после того, как пользователь проходит аутентификацию. Максимальная длина строки в символах — 8000.
sso_binding enum BindingType
Тип привязки для Single Sign-on. Большинство поставщиков поддерживают тип привязки POST.
Привязка — это отображение сообщения протокола SAML на стандартные форматы сообщений и / или протоколы связи.
  • POST: Привязка HTTP POST.
  • REDIRECT: Привязка перенаправлением HTTP.
  • ARTIFACT: Привязка артефактом HTTP.
    sso_url string
    Обязательное поле. URL для Single sign-on. Укажите здесь ссылку на страницу для входа в IdP. Максимальная длина строки в символах — 8000.
    security_settings FederationSecuritySettings
    Настройки безопасности федерации.
    case_insensitive_name_ids bool
    Использовать нечувствительные к регистру Name ID пользователей.

    FederationSecuritySettings

    Поле Описание
    encrypted_assertions bool
    Включить шифрование утверждений.

    List

    Возвращает список федераций в указанном каталоге.

    rpc List (ListFederationsRequest) returns (ListFederationsResponse)

    ListFederationsRequest

    Поле Описание
    scope oneof: cloud_id или folder_id
      cloud_id string
    Идентификатор облака, для которого запрашивается список федераций. Чтобы получить идентификатор облака, используйте запрос yandex.cloud.resourcemanager.v1.CloudService.List. Максимальная длина строки в символах — 50.
      folder_id string
    Идентификатор каталога для получения списка федераций. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50.
    page_size int64
    Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListFederationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
    page_token string
    Токен страницы. Установите значение page_token равным значению поля ListFederationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 50.
    filter string
    1. Имя поля. В настоящее время фильтрация осуществляется только по полю Federation.name.
    2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений.
    3. Значение. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9]$.
    Максимальная длина строки в символах — 1000.

    ListFederationsResponse

    Поле Описание
    federations[] Federation
    Список федераций.
    next_page_token string
    Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListFederationsRequest.page_size, используйте next_page_token в качестве значения параметра ListFederationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

    Federation

    Поле Описание
    id string
    Обязательное поле. Идентификатор федерации. Максимальная длина строки в символах — 50.
    folder_id string
    Обязательное поле. Идентификатор каталога, которому принадлежит федерация. Максимальная длина строки в символах — 50.
    name string
    Обязательное поле. Имя федерации. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
    description string
    Описание федерации. Максимальная длина строки в символах — 256.
    created_at google.protobuf.Timestamp
    Время создания.
    cookie_max_age google.protobuf.Duration
    Время жизни файлов cookie в браузере в секундах. Если время жизни cookie не истекло, то консоль управления сразу аутентифицирует пользователя и отправляет на главную страницу. Допустимые значения — от 10m до 12h включительно.
    auto_create_account_on_login bool
    Добавлять новых пользователей автоматически при успешной аутентификации. Пользователям будет назначена роль resource-manager.clouds.member автоматически, но остальные роли надо будет назначить самостоятельно.
    Если значение false, то пользователь, которого не добавили в облако, не сможет войти, даже если пройдет аутентификацию на вашем сервере.
    issuer string
    Обязательное поле. Идентификатор IdP-сервера, который будет использоваться для аутентификации. Этот же идентификатор сервер IdP указывает в ответе после того, как пользователь проходит аутентификацию. Максимальная длина строки в символах — 8000.
    sso_binding enum BindingType
    Тип привязки для Single Sign-on. Большинство поставщиков поддерживают тип привязки POST.
    Привязка — это отображение сообщения протокола SAML на стандартные форматы сообщений и / или протоколы связи.
    • POST: Привязка HTTP POST.
    • REDIRECT: Привязка перенаправлением HTTP.
    • ARTIFACT: Привязка артефактом HTTP.
      sso_url string
      Обязательное поле. URL для Single sign-on. Укажите здесь ссылку на страницу для входа в IdP. Максимальная длина строки в символах — 8000.
      security_settings FederationSecuritySettings
      Настройки безопасности федерации.
      case_insensitive_name_ids bool
      Использовать нечувствительные к регистру Name ID пользователей.

      FederationSecuritySettings

      Поле Описание
      encrypted_assertions bool
      Включить шифрование утверждений.

      Create

      Создает федерацию в указанном каталоге.

      rpc Create (CreateFederationRequest) returns (operation.Operation)

      Метаданные и результат операции:

          Operation.metadata:CreateFederationMetadata

          Operation.response:Federation

      CreateFederationRequest

      Поле Описание
      folder_id string
      Идентификатор каталога, в котором создается федерация. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50.
      name string
      Название федерации. Имя должно быть уникальным в облаке. Значение должно соответствовать регулярному выражению [a-z]([-a-z0-9]{0,61}[a-z0-9])?.
      description string
      Описание федерации. Максимальная длина строки в символах — 256.
      cookie_max_age google.protobuf.Duration
      Время жизни файлов cookie в браузере в секундах. Если время жизни cookie не истекло, то консоль управления сразу аутентифицирует пользователя и отправляет на главную страницу. Значение по умолчанию — 8h. Допустимые значения — от 10m до 12h включительно.
      auto_create_account_on_login bool
      Добавлять новых пользователей автоматически при успешной аутентификации. Пользователям будет назначена роль resource-manager.clouds.member автоматически, но остальные роли надо будет назначить самостоятельно.
      Если значение false, то пользователь, которого не добавили в облако, не сможет войти, даже если пройдет аутентификацию на вашем сервере.
      issuer string
      Обязательное поле. Идентификатор IdP-сервера, который будет использоваться для аутентификации. Этот же идентификатор сервер IdP указывает в ответе после того, как пользователь проходит аутентификацию. Максимальная длина строки в символах — 8000.
      sso_binding enum BindingType
      Тип привязки для Single Sign-on. Большинство поставщиков поддерживают тип привязки POST.
      Привязка — это отображение сообщения протокола SAML на стандартные форматы сообщений и / или протоколы связи.
      • POST: Привязка HTTP POST.
      • REDIRECT: Привязка перенаправлением HTTP.
      • ARTIFACT: Привязка артефактом HTTP.
        sso_url string
        Обязательное поле. URL для Single sign-on. Укажите здесь ссылку на страницу для входа в IdP. Максимальная длина строки в символах — 8000.
        security_settings FederationSecuritySettings
        Настройки безопасности федерации.
        case_insensitive_name_ids bool
        Использовать нечувствительные к регистру Name ID пользователей.

        FederationSecuritySettings

        Поле Описание
        encrypted_assertions bool
        Включить шифрование утверждений.

        Operation

        Поле Описание
        id string
        Идентификатор операции.
        description string
        Описание операции. Длина описания должна быть от 0 до 256 символов.
        created_at google.protobuf.Timestamp
        Время создания ресурса в формате в RFC3339.
        created_by string
        Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
        modified_at google.protobuf.Timestamp
        Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
        done bool
        Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
        metadata google.protobuf.Any<CreateFederationMetadata>
        Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
        result oneof: error или response
        Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
          error google.rpc.Status
        Описание ошибки в случае сбоя или отмены операции.
          response google.protobuf.Any<Federation>
        в случае успешного выполнения операции.

        CreateFederationMetadata

        Поле Описание
        federation_id string
        Идентификатор создаваемой федерации.

        Federation

        Поле Описание
        id string
        Обязательное поле. Идентификатор федерации. Максимальная длина строки в символах — 50.
        folder_id string
        Обязательное поле. Идентификатор каталога, которому принадлежит федерация. Максимальная длина строки в символах — 50.
        name string
        Обязательное поле. Имя федерации. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
        description string
        Описание федерации. Максимальная длина строки в символах — 256.
        created_at google.protobuf.Timestamp
        Время создания.
        cookie_max_age google.protobuf.Duration
        Время жизни файлов cookie в браузере в секундах. Если время жизни cookie не истекло, то консоль управления сразу аутентифицирует пользователя и отправляет на главную страницу. Допустимые значения — от 10m до 12h включительно.
        auto_create_account_on_login bool
        Добавлять новых пользователей автоматически при успешной аутентификации. Пользователям будет назначена роль resource-manager.clouds.member автоматически, но остальные роли надо будет назначить самостоятельно.
        Если значение false, то пользователь, которого не добавили в облако, не сможет войти, даже если пройдет аутентификацию на вашем сервере.
        issuer string
        Обязательное поле. Идентификатор IdP-сервера, который будет использоваться для аутентификации. Этот же идентификатор сервер IdP указывает в ответе после того, как пользователь проходит аутентификацию. Максимальная длина строки в символах — 8000.
        sso_binding enum BindingType
        Тип привязки для Single Sign-on. Большинство поставщиков поддерживают тип привязки POST.
        Привязка — это отображение сообщения протокола SAML на стандартные форматы сообщений и / или протоколы связи.
        • POST: Привязка HTTP POST.
        • REDIRECT: Привязка перенаправлением HTTP.
        • ARTIFACT: Привязка артефактом HTTP.
          sso_url string
          Обязательное поле. URL для Single sign-on. Укажите здесь ссылку на страницу для входа в IdP. Максимальная длина строки в символах — 8000.
          security_settings FederationSecuritySettings
          Настройки безопасности федерации.
          case_insensitive_name_ids bool
          Использовать нечувствительные к регистру Name ID пользователей.

          FederationSecuritySettings

          Поле Описание
          encrypted_assertions bool
          Включить шифрование утверждений.

          Update

          Изменяет указанную федерацию.

          rpc Update (UpdateFederationRequest) returns (operation.Operation)

          Метаданные и результат операции:

              Operation.metadata:UpdateFederationMetadata

              Operation.response:Federation

          UpdateFederationRequest

          Поле Описание
          federation_id string
          Идентификатор федерации для обновления. Чтобы получить идентификатор федерации, используйте запрос FederationService.List. Максимальная длина строки в символах — 50.
          update_mask google.protobuf.FieldMask
          Маска, определяющая, какие поля указанной федерации будут обновлены.
          name string
          Название федерации. Имя должно быть уникальным в облаке. Значение должно соответствовать регулярному выражению |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.
          description string
          Описание федерации. Максимальная длина строки в символах — 256.
          cookie_max_age google.protobuf.Duration
          Время жизни файлов cookie в браузере в секундах. Если время жизни cookie не истекло, то консоль управления сразу аутентифицирует пользователя и отправляет на главную страницу. Значение по умолчанию — 8h. Допустимые значения — от 10m до 12h включительно.
          auto_create_account_on_login bool
          Добавлять новых пользователей автоматически при успешной аутентификации. Пользователям будет назначена роль resource-manager.clouds.member автоматически, но остальные роли надо будет назначить самостоятельно.
          Если значение false, то пользователь, которого не добавили в облако, не сможет войти, даже если пройдет аутентификацию на вашем сервере.
          issuer string
          Обязательное поле. Идентификатор IdP-сервера, который будет использоваться для аутентификации. Этот же идентификатор сервер IdP указывает в ответе после того, как пользователь проходит аутентификацию. Максимальная длина строки в символах — 8000.
          sso_binding enum BindingType
          Тип привязки для Single Sign-on. Большинство поставщиков поддерживают тип привязки POST.
          Привязка — это отображение сообщения протокола SAML на стандартные форматы сообщений и / или протоколы связи.
          • POST: Привязка HTTP POST.
          • REDIRECT: Привязка перенаправлением HTTP.
          • ARTIFACT: Привязка артефактом HTTP.
            sso_url string
            Обязательное поле. URL для Single sign-on. Укажите здесь ссылку на страницу для входа в IdP. Максимальная длина строки в символах — 8000.
            security_settings FederationSecuritySettings
            Настройки безопасности федерации.
            case_insensitive_name_ids bool
            Использовать нечувствительные к регистру Name ID пользователей.

            FederationSecuritySettings

            Поле Описание
            encrypted_assertions bool
            Включить шифрование утверждений.

            Operation

            Поле Описание
            id string
            Идентификатор операции.
            description string
            Описание операции. Длина описания должна быть от 0 до 256 символов.
            created_at google.protobuf.Timestamp
            Время создания ресурса в формате в RFC3339.
            created_by string
            Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
            modified_at google.protobuf.Timestamp
            Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
            done bool
            Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
            metadata google.protobuf.Any<UpdateFederationMetadata>
            Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
            result oneof: error или response
            Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
              error google.rpc.Status
            Описание ошибки в случае сбоя или отмены операции.
              response google.protobuf.Any<Federation>
            в случае успешного выполнения операции.

            UpdateFederationMetadata

            Поле Описание
            federation_id string
            Идентификатор федерации, которая обновляется.

            Federation

            Поле Описание
            id string
            Обязательное поле. Идентификатор федерации. Максимальная длина строки в символах — 50.
            folder_id string
            Обязательное поле. Идентификатор каталога, которому принадлежит федерация. Максимальная длина строки в символах — 50.
            name string
            Обязательное поле. Имя федерации. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
            description string
            Описание федерации. Максимальная длина строки в символах — 256.
            created_at google.protobuf.Timestamp
            Время создания.
            cookie_max_age google.protobuf.Duration
            Время жизни файлов cookie в браузере в секундах. Если время жизни cookie не истекло, то консоль управления сразу аутентифицирует пользователя и отправляет на главную страницу. Допустимые значения — от 10m до 12h включительно.
            auto_create_account_on_login bool
            Добавлять новых пользователей автоматически при успешной аутентификации. Пользователям будет назначена роль resource-manager.clouds.member автоматически, но остальные роли надо будет назначить самостоятельно.
            Если значение false, то пользователь, которого не добавили в облако, не сможет войти, даже если пройдет аутентификацию на вашем сервере.
            issuer string
            Обязательное поле. Идентификатор IdP-сервера, который будет использоваться для аутентификации. Этот же идентификатор сервер IdP указывает в ответе после того, как пользователь проходит аутентификацию. Максимальная длина строки в символах — 8000.
            sso_binding enum BindingType
            Тип привязки для Single Sign-on. Большинство поставщиков поддерживают тип привязки POST.
            Привязка — это отображение сообщения протокола SAML на стандартные форматы сообщений и / или протоколы связи.
            • POST: Привязка HTTP POST.
            • REDIRECT: Привязка перенаправлением HTTP.
            • ARTIFACT: Привязка артефактом HTTP.
              sso_url string
              Обязательное поле. URL для Single sign-on. Укажите здесь ссылку на страницу для входа в IdP. Максимальная длина строки в символах — 8000.
              security_settings FederationSecuritySettings
              Настройки безопасности федерации.
              case_insensitive_name_ids bool
              Использовать нечувствительные к регистру Name ID пользователей.

              FederationSecuritySettings

              Поле Описание
              encrypted_assertions bool
              Включить шифрование утверждений.

              Delete

              Удаляет указанную федерацию.

              rpc Delete (DeleteFederationRequest) returns (operation.Operation)

              Метаданные и результат операции:

                  Operation.metadata:DeleteFederationMetadata

                  Operation.response:google.protobuf.Empty

              DeleteFederationRequest

              Поле Описание
              federation_id string
              Идентификатор федерации, которую следует удалить. Чтобы получить идентификатор федерации, используйте запрос FederationService.List. Максимальная длина строки в символах — 50.

              Operation

              Поле Описание
              id string
              Идентификатор операции.
              description string
              Описание операции. Длина описания должна быть от 0 до 256 символов.
              created_at google.protobuf.Timestamp
              Время создания ресурса в формате в RFC3339.
              created_by string
              Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
              modified_at google.protobuf.Timestamp
              Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
              done bool
              Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
              metadata google.protobuf.Any<DeleteFederationMetadata>
              Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
              result oneof: error или response
              Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                error google.rpc.Status
              Описание ошибки в случае сбоя или отмены операции.
                response google.protobuf.Any<google.protobuf.Empty>
              в случае успешного выполнения операции.

              DeleteFederationMetadata

              Поле Описание
              federation_id string
              Идентификатор удаляемой федерации.

              AddUserAccounts

              Добавляет пользователей в указанную федерацию.

              rpc AddUserAccounts (AddFederatedUserAccountsRequest) returns (operation.Operation)

              Метаданные и результат операции:

                  Operation.metadata:AddFederatedUserAccountsMetadata

                  Operation.response:AddFederatedUserAccountsResponse

              AddFederatedUserAccountsRequest

              Поле Описание
              federation_id string
              Идентификатор федерации для добавления пользователей. Максимальная длина строки в символах — 50.
              name_ids[] string
              Name ID пользователей, которые возвращает поставщик удостоверений (IdP) после успешной аутентификации. Это могут быть UPN или email пользователей. Максимальная длина строки в символах для каждого значения — 1000.

              Operation

              Поле Описание
              id string
              Идентификатор операции.
              description string
              Описание операции. Длина описания должна быть от 0 до 256 символов.
              created_at google.protobuf.Timestamp
              Время создания ресурса в формате в RFC3339.
              created_by string
              Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
              modified_at google.protobuf.Timestamp
              Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
              done bool
              Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
              metadata google.protobuf.Any<AddFederatedUserAccountsMetadata>
              Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
              result oneof: error или response
              Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                error google.rpc.Status
              Описание ошибки в случае сбоя или отмены операции.
                response google.protobuf.Any<AddFederatedUserAccountsResponse>
              в случае успешного выполнения операции.

              AddFederatedUserAccountsMetadata

              Поле Описание
              federation_id string
              Идентификатор изменяемой Федерации.

              AddFederatedUserAccountsResponse

              Поле Описание
              user_accounts[] UserAccount
              Список пользователей, созданных с помощью запроса FederationService.AddUsers.

              UserAccount

              Поле Описание
              id string
              Идентификатор аккаунта пользователя
              user_account oneof: yandex_passport_user_account или saml_user_account
                yandex_passport_user_account YandexPassportUserAccount
              Ресурс YandexPassportUserAccount.
                saml_user_account SamlUserAccount
              Пользователь федерации.

              YandexPassportUserAccount

              Поле Описание
              login string
              Логин аккаунта Яндекс.Паспорта.
              default_email string
              Email используемый по умолчанию для пользователя с аккаунтом Яндекс.Паспорта.

              SamlUserAccount

              Поле Описание
              federation_id string
              Обязательное поле. Идентификатор федерации, которой принадлежит пользователь. Максимальная длина строки в символах — 50.
              name_id string
              Обязательное поле. Идентификатор имени пользоваетля федерации. Идентификатор имени должен быть уникальным в федерации. Длина 1-256 символов. Длина строки в символах должна быть от 1 до 256.
              attributes map<string,Attribute>
              Дополнительные атрибуты пользователя.

              Attribute

              Поле Описание
              value[] string

              ListUserAccounts

              Возвращает список пользователей для указанной федерации.

              rpc ListUserAccounts (ListFederatedUserAccountsRequest) returns (ListFederatedUserAccountsResponse)

              ListFederatedUserAccountsRequest

              Поле Описание
              federation_id string
              Обязательное поле. Идентификатор федерации для перечисления пользователей. Максимальная длина строки в символах — 50.
              page_size int64
              Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListFederatedUserAccountsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
              page_token string
              Токен страницы. Установите значение page_token равным значению поля ListFederatedUserAccountsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

              ListFederatedUserAccountsResponse

              Поле Описание
              user_accounts[] UserAccount
              Список пользователей для указанной федерации.
              next_page_token string
              Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListFederatedUserAccountsRequest.page_size, используйте next_page_token в качестве значения параметра ListFederatedUserAccountsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

              UserAccount

              Поле Описание
              id string
              Идентификатор аккаунта пользователя
              user_account oneof: yandex_passport_user_account или saml_user_account
                yandex_passport_user_account YandexPassportUserAccount
              Ресурс YandexPassportUserAccount.
                saml_user_account SamlUserAccount
              Пользователь федерации.

              YandexPassportUserAccount

              Поле Описание
              login string
              Логин аккаунта Яндекс.Паспорта.
              default_email string
              Email используемый по умолчанию для пользователя с аккаунтом Яндекс.Паспорта.

              SamlUserAccount

              Поле Описание
              federation_id string
              Обязательное поле. Идентификатор федерации, которой принадлежит пользователь. Максимальная длина строки в символах — 50.
              name_id string
              Обязательное поле. Идентификатор имени пользоваетля федерации. Идентификатор имени должен быть уникальным в федерации. Длина 1-256 символов. Длина строки в символах должна быть от 1 до 256.
              attributes map<string,Attribute>
              Дополнительные атрибуты пользователя.

              Attribute

              Поле Описание
              value[] string

              ListOperations

              Возвращает список операций для указанной федерации.

              rpc ListOperations (ListFederationOperationsRequest) returns (ListFederationOperationsResponse)

              ListFederationOperationsRequest

              Поле Описание
              federation_id string
              Идентификатор федерации для перечисления операций. Максимальная длина строки в символах — 50.
              page_size int64
              Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение [ListFederationOperationsOperationsResponse.next_page_token], которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
              page_token string
              Токен страницы. Установите значение page_token равным значению поля ListFederationOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

              ListFederationOperationsResponse

              Поле Описание
              operations[] operation.Operation
              Список операций для указанной федерации.
              next_page_token string
              Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListFederationOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListFederationOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

              Operation

              Поле Описание
              id string
              Идентификатор операции.
              description string
              Описание операции. Длина описания должна быть от 0 до 256 символов.
              created_at google.protobuf.Timestamp
              Время создания ресурса в формате в RFC3339.
              created_by string
              Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
              modified_at google.protobuf.Timestamp
              Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
              done bool
              Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
              metadata google.protobuf.Any
              Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
              result oneof: error или response
              Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                error google.rpc.Status
              Описание ошибки в случае сбоя или отмены операции.
                response google.protobuf.Any
              Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.
              В этой статье: