Managed Service for Apache Kafka® API, gRPC: UserService.Get
Returns the specified Kafka user.
To get the list of available Kafka users, make a List request.
gRPC request
rpc Get (GetUserRequest) returns (User)
GetUserRequest
{
"clusterId": "string",
"userName": "string"
}
|
Field |
Description |
|
clusterId |
string Required field. ID of the Apache Kafka® cluster the user belongs to. To get the cluster ID, make a ClusterService.List request. |
|
userName |
string Required field. Name of the Kafka user to return. To get the name of the user, make a UserService.List request. |
User
{
"name": "string",
"clusterId": "string",
"permissions": [
{
"topicName": "string",
"role": "AccessRole",
"allowHosts": [
"string"
]
}
]
}
A Kafka user.
For more information, see the Operations -> Accounts section of the documentation.
|
Field |
Description |
|
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[] |
Set of permissions granted to this user. |
Permission
|
Field |
Description |
|
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 |
enum AccessRole Access role type to grant to the user.
|
|
allowHosts[] |
string Lists hosts allowed for this permission. Bare in mind that the same host might appear in multiple permissions at the same time, |