Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Managed Service for Apache Kafka®
  • Getting started
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • GrantPermission
        • RevokePermission
  • Yandex Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes
  • FAQ

In this article:

  • gRPC request
  • GetUserRequest
  • User
  • Permission
  1. API reference
  2. gRPC
  3. User
  4. Get

Managed Service for Apache Kafka® API, gRPC: UserService.Get

Written by
Yandex Cloud
Updated at April 18, 2025
  • gRPC request
  • GetUserRequest
  • User
  • Permission

Returns the specified Kafka user.

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

gRPC requestgRPC request

rpc Get (GetUserRequest) returns (User)

GetUserRequestGetUserRequest

{
  "cluster_id": "string",
  "user_name": "string"
}

Field

Description

cluster_id

string

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

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

user_name

string

Required field. Name of the Kafka user to return.

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

UserUser

{
  "name": "string",
  "cluster_id": "string",
  "permissions": [
    {
      "topic_name": "string",
      "role": "AccessRole",
      "allow_hosts": [
        "string"
      ]
    }
  ]
}

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

Field

Description

name

string

Name of the Kafka user.

cluster_id

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.

PermissionPermission

Field

Description

topic_name

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

enum AccessRole

Access role type to grant to the user.

  • 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.
  • ACCESS_ROLE_TOPIC_ADMIN: Admin permissions on topics role for the user.

allow_hosts[]

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.

Was the article helpful?

Previous
Overview
Next
List
Yandex project
© 2025 Yandex.Cloud LLC