Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Cloud Organization
  • Начало работы
  • Управление организациями
    • Создать организацию
    • Изменить данные организации
    • Переключиться на другую организацию
  • Управление пользователями
    • Обзор
    • Добавить пользователя
    • Получить идентификатор или почту пользователя
    • Назначить права доступа
    • Удалить аккаунт пользователя
  • Управление группами пользователей
  • Управление федерациями удостоверений
    • Настроить федерацию удостоверений
    • Аутентификация с помощью Active Directory
    • Аутентификация с помощью Google Workspace
    • Аутентификация с помощью Azure Active Directory
    • Аутентификация с помощью Keycloak
    • Аутентификация с помощью SAML-совместимой федерации удостоверений
  • Управление облаками и сервисами
  • Справочник API
    • Аутентификация
    • 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
  • Правила тарификации
  1. Справочник API
  2. gRPC (англ.)
  3. UserService

Cloud Organization API, gRPC: UserService

Статья создана
Yandex Cloud
  • Calls UserService
  • ListMembers
    • ListMembersRequest
    • ListMembersResponse
    • OrganizationUser
  • DeleteMembership
    • DeleteMembershipRequest
    • Operation
    • DeleteMembershipMetadata
    • DeleteMembershipResponse

A set of methods for managing Organization users.

Call Description
ListMembers List organization active members.
DeleteMembership Delete user membership.

Calls UserService

ListMembers

List organization active members.

rpc ListMembers (ListMembersRequest) returns (ListMembersResponse)

ListMembersRequest

Field Description
organization_id string
Required. ID of the Organization resource to list members for. The maximum string length in characters is 50.
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 ListMembersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token string
Page token. Set page_token to the ListMembersResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 2000.

ListMembersResponse

Field Description
users[] OrganizationUser
List of users for the specified organization.
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 ListMembersRequest.page_size, use the next_page_token as the value for the ListMembersRequest.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.

OrganizationUser

Field Description
subject_claims yandex.cloud.oauth.SubjectClaims
OpenID standard claims with additional Cloud Organization claims.

DeleteMembership

Delete user membership.

rpc DeleteMembership (DeleteMembershipRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteMembershipMetadata

    Operation.response:DeleteMembershipResponse

DeleteMembershipRequest

Field Description
organization_id string
Required. ID of the organization to delete membership. The maximum string length in characters is 50.
subject_id string
ID of the subject that is being deleted from organization. By default equals to authenticated subject. The maximum string length in characters is 50.

Operation

Field Description
id string
ID of the operation.
description string
Description of the operation. 0-256 characters long.
created_at google.protobuf.Timestamp
Creation timestamp.
created_by string
ID of the user or service account who initiated the operation.
modified_at google.protobuf.Timestamp
The time when the Operation resource was last modified.
done bool
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata google.protobuf.Any<DeleteMembershipMetadata>
Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result oneof: error or response
The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<DeleteMembershipResponse>
if operation finished successfully.

DeleteMembershipMetadata

Field Description
organization_id string
Required. ID of the organization to delete membership. The maximum string length in characters is 50.
subject_id string
Required. ID of the subject that is being deleted from organization. The maximum string length in characters is 50.

DeleteMembershipResponse

Field Description
organization_id string
Required. ID of the organization to delete membership. The maximum string length in characters is 50.
subject_id string
Required. ID of the subject that is being deleted from organization. The maximum string length in characters is 50.

Была ли статья полезна?

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • Calls UserService
  • ListMembers
  • ListMembersRequest
  • ListMembersResponse
  • OrganizationUser
  • DeleteMembership
  • DeleteMembershipRequest
  • Operation
  • DeleteMembershipMetadata
  • DeleteMembershipResponse