Get

Returns the specified Kafka user.

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

TypeScript

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);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.mdb.clickhouse.v1.user_service_pb2 import GetUserRequest
from yandex.cloud.mdb.clickhouse.v1.user_service_pb2_grpc import UserServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(UserServiceStub)
response = service.Get(GetUserRequest(cluster_id="clusterId", user_name="userName"))
print(response)

GetUserRequest

clusterId : string

ID of the Apache Kafka® cluster the user belongs to.

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

userName : string

Name of the Kafka user to return.

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

User

A Kafka user. For more information, see the Operations - Accounts section of the documentation.

name : string

Name of the Kafka user.

clusterId : string

ID of the Apache Kafka® cluster the user belongs to.

To get the Apache Kafka® cluster ID, make a ClusterService.List request.

permissions : Permission

Set of permissions granted to this user.

Permission

AccessRole

• ACCESS_ROLE_UNSPECIFIED

• ACCESS_ROLE_PRODUCER

  Producer role for the user.

• ACCESS_ROLE_CONSUMER

  Consumer role for the user.

• ACCESS_ROLE_ADMIN

  Admin role for the user.

topicName : string

Name or prefix-pattern with wildcard for the topic that the permission grants access to.

To get the topic name, make a TopicService.List request.

role : AccessRole

Access role type to grant to the user.

allowHosts : string

Lists hosts allowed for this permission. Only ip-addresses allowed as value of single host. When not defined, access from any host is allowed.

Bare in mind that the same host might appear in multiple permissions at the same time, hence removing individual permission doesn't automatically restricts access from the allow_hosts of the permission. If the same host(s) is listed for another permission of the same principal/topic, the host(s) remains allowed.

---