Managed Service for Apache Kafka® API, gRPC: UserService.List
Retrieves the list of Kafka users in the specified cluster.
gRPC request
rpc List (ListUsersRequest) returns (ListUsersResponse)
ListUsersRequest
{
"cluster_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the Apache Kafka® cluster to list Kafka users in. To get the Apache Kafka® cluster ID, make a ClusterService.List request. |
|
page_size |
int64 The maximum number of results per page to return. If the number of available results is larger than |
|
page_token |
string Page token. To get the next page of results, set |
ListUsersResponse
{
"users": [
{
"name": "string",
"cluster_id": "string",
"permissions": [
{
"topic_name": "string",
"role": "AccessRole",
"allow_hosts": [
"string"
]
}
]
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
users[] |
List of Kafka users. |
|
next_page_token |
string This token allows you to get the next page of results for list requests. If the number of results is larger than ListUsersRequest.page_size, use the |
User
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[] |
Set of permissions granted to this user. |
Permission
|
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.
|
|
allow_hosts[] |
string Lists hosts allowed for this permission. Bare in mind that the same host might appear in multiple permissions at the same time, |