Skip to main content

Get

Returns the specified SQL Server user.

To get the list of available SQL Server users, make a List request.

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

const GetUserRequest = cloudApi.mdb.clickhouse_user_service.GetUserRequest;

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

  const result = await client.get(
    GetUserRequest.fromPartial({
      clusterId: "clusterId",
      userName: "userName",
    })
  );
  console.log(result);
})();

GetUserRequest​

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 SQL Server user to return.

To get the name of the user use a DatabaseService.List request.

User​

An SQL Server user.

name : string​

Name of the SQL Server user.

clusterId : string​

ID of the SQL Server cluster the user belongs to.

permissions : Permission​

Set of permissions granted to the user.

serverRoles : ServerRole​

Set of server roles granted to the login.

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.