Skip to main content

GrantPermission

Grants a permission to the specified SQL Server user.

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

const GrantUserPermissionRequest =
  cloudApi.mdb.clickhouse_user_service.GrantUserPermissionRequest;
const User = cloudApi.datasphere.user.User;

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

  const operation = await client.grantPermission(
    GrantUserPermissionRequest.fromPartial({
      clusterId: "clusterId",
      userName: "userName",
      // permission: {
      // databaseName: "databaseName"
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

GrantUserPermissionRequest​

clusterId : string​

ID of the SQL Server cluster the user belongs to.

To get the cluster ID, use a ClusterService.List request.

userName : string​

Name of the user to grant the permission to.

To get the name of the user, use a UserService.List request.

permission : Permission​

Permission that should be granted to the specified user.

Permission​

Role​

Role granted to the user within the database.

  • ROLE_UNSPECIFIED

    Role granted to the user within the database.

  • DB_OWNER

    Members of this fixed database role can perform all configuration and maintenance activities on a database and can also drop a database in SQL Server.

  • DB_SECURITYADMIN

    Members of this fixed database role can modify role membership for custom roles only and manage permissions. They can potentially elevate their privileges and their actions should be monitored.

  • DB_ACCESSADMIN

    Members of this fixed database role can add or remove access to a database for Windows logins, Windows groups, and SQL Server logins.

  • DB_BACKUPOPERATOR

    Members of this fixed database role can back up the database.

  • DB_DDLADMIN

    Members of this fixed database role can run any Data Definition Language (DDL) command in a database.

  • DB_DATAWRITER

    Members of this fixed database role can add, delete, or change data in all user tables.

  • DB_DATAREADER

    Members of this fixed database role can read all data from all user tables.

  • DB_DENYDATAWRITER

    Members of this fixed database role cannot add, modify, or delete any data in the user tables within a database. A denial has a higher priority than a grant, so you can use this role to quickly restrict one's privileges without explicitly revoking permissions or roles.

  • DB_DENYDATAREADER

    Members of this fixed database role cannot read any data in the user tables within a database. A denial has a higher priority than a grant, so you can use this role to quickly restrict one's privileges without explicitly revoking permissions or roles.

databaseName : string​

Name of the database the permission grants access to.

roles : Role​

Roles granted to the user within the database.

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.