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
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
|
Field |
Description |
|
clusterId |
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. |
|
pageSize |
int64 The maximum number of results per page to return. If the number of available results is larger than |
|
pageToken |
string Page token. To get the next page of results, set |
ListUsersResponse
{
"users": [
{
"name": "string",
"clusterId": "string",
"permissions": [
{
"topicName": "string",
"role": "AccessRole",
"allowHosts": [
"string"
]
}
]
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
users[] |
List of Kafka users. |
|
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results is larger than ListUsersRequest.pageSize, 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. |
|
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, |