Skip to main content

UpdateAccessBindings

Updates access bindings for the snapshot.

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const AccessBindingAction = cloudApi.access.access.AccessBindingAction;
const AccessBindingsOperationResult =
  cloudApi.access.access.AccessBindingsOperationResult;
const UpdateAccessBindingsRequest =
  cloudApi.access.access.UpdateAccessBindingsRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.SnapshotServiceClient);

  const operation = await client.updateAccessBindings(
    access.UpdateAccessBindingsRequest.fromPartial({
      resourceId: "resourceId",
      // accessBindingDeltas: [{
      // action: AccessBindingAction.ADD,
      // accessBinding: {
      // roleId: "roleId",
      // subject: {
      // id: "id",
      // type: "type"
      // }
      // }
      // }]
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof access.AccessBindingsOperationResult>(
      finishedOp.response
    );
    console.log(result);
  }
})();

UpdateAccessBindingsRequest​

resourceId : string​

ID of the resource for which access bindings are being updated.

accessBindingDeltas : AccessBindingDelta​

Updates to access bindings.

AccessBindingDelta​

action : AccessBindingAction​

The action that is being performed on an access binding.

accessBinding : AccessBinding​

Access binding. For more information, see Access Bindings.

AccessBinding​

roleId : string​

ID of the yandex.cloud.iam.v1.Role that is assigned to the subject.

subject : Subject​

Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

Subject​

id : string​

ID of the subject.

It can contain one of the following values:

  • allAuthenticatedUsers: A special public group that represents anyone who is authenticated. It can be used only if the type is system.
  • allUsers: A special public group that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. It can be used only if the type is system.
  • group:organization:<id>:users: A special system group that represents all members of organization with given <id>. It can be used only if the type is system.
  • group:federation:<id>:users: A special system group that represents all users of federation with given <id>. It can be used only if the type is system.
  • <cloud generated id>: An identifier that represents a user account. It can be used only if the type is userAccount, federatedUser or serviceAccount.
type : string​

Type of the subject.

It can contain one of the following values:

  • userAccount: An account on Yandex or Yandex Connect, added to Yandex Cloud.
  • serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource.
  • federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory.
  • system: System group. This type represents several accounts with a common system identifier.

For more information, see Subject to which the role is assigned.

Operation​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

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

modifiedAt : 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​

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.

One of result​

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