Contact UsGet started

Cloud Organization API, gRPC: GroupService.UpdateMembers

Written by
Updated at November 26, 2024

Update group members.

gRPC request

rpc UpdateMembers (UpdateGroupMembersRequest) returns (operation.Operation)

UpdateGroupMembersRequest

{
  "group_id": "string",
  "member_deltas": [
    {
      "action": "MemberAction",
      "subject_id": "string"
    }
  ]
}

Field

Description

group_id

string

Required field. ID of the group to update.
To get the group ID, use a GroupService.List request.

member_deltas[]

MemberDelta

Updates to group members.

MemberDelta

Field

Description

action

enum MemberAction

Required field. The action that is being performed on a group member.

  • MEMBER_ACTION_UNSPECIFIED
  • ADD: Addition of a group member.
  • REMOVE: Removal of a group member.

subject_id

string

Required field. ID of the subject that is being added or removed from a group.

Subject type can be one of following values:

  • userAccount: An account on Yandex, added to Yandex Cloud.
  • federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "group_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Empty"
  // end of the list of possible fields
}

An Operation resource. For more information, see 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

UpdateGroupMembersMetadata

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.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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.

response

google.protobuf.Empty

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, 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.

UpdateGroupMembersMetadata

Field

Description

group_id

string

ID of the group that is being updated.
Previous
ListMembers
Next
ListAccessBindings