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 user groups
  • 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. Group
  4. updateMembers

Method updateMembers

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

Update group members.

HTTP request

POST https://organization-manager.api.cloud.yandex.net/organization-manager/v1/groups/{groupId}:updateMembers

Path parameters

Parameter Description
groupId

Required. ID of the group to update. To get the group ID, use a list request.

The maximum string length in characters is 50.

Body parameters

{
  "memberDeltas": [
    {
      "action": "string",
      "subjectId": "string"
    }
  ]
}
Field Description
memberDeltas[] object

Required. Updates to group members.

The number of elements must be in the range 1-1000.

memberDeltas[].
action
string

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

  • ADD: Addition of a group member.
  • REMOVE: Removal of a group member.
memberDeltas[].
subjectId
string

Required. 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.

The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // 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.

createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format.

createdBy string

ID of the user or service account who initiated the operation.

modifiedAt string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format.

done boolean (boolean)

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 object

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 object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

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.

Was the article helpful?

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