Method list
Retrieves the list of Kafka users in the specified cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/users
Path parameters
| Parameter | Description |
|---|---|
| clusterId | Required. ID of the Apache Kafka® cluster to list Kafka users in. To get the Apache Kafka® cluster ID, make a list request. The maximum string length in characters is 50. |
Query parameters
| Parameter | Description |
|---|---|
| pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
| pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"users": [
{
"name": "string",
"clusterId": "string",
"permissions": [
{
"topicName": "string",
"role": "string"
}
]
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| users[] | object A Kafka user. For more information, see the Operations -> Accounts section of the documentation. |
| users[]. name |
string Name of the Kafka user. |
| users[]. clusterId |
string ID of the Apache Kafka® cluster the user belongs to. To get the Apache Kafka® cluster ID, make a list request. |
| users[]. permissions[] |
object Set of permissions granted to this user. |
| users[]. permissions[]. topicName |
string Name or prefix-pattern with wildcard for the topic that the permission grants access to. To get the topic name, make a list request. |
| users[]. permissions[]. role |
string Access role type to grant to the user.
|
| nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |