Contact UsGet started

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

Written by
Updated at April 18, 2025

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_size, the service returns a ListUsersResponse.next_page_token that can be used to get the next page of results in subsequent list requests.

page_token

string

Page token.

To get the next page of results, set page_token to the ListUsersResponse.next_page_token returned by the previous list request.

ListUsersResponse

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

Field

Description

users[]

User

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 next_page_token as the value for the ListUsersRequest.page_token parameter in the next list request.
Each subsequent list request will have its own next_page_token to continue paging through the results.

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[]

Permission

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.

  • 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.
Previous
Get
Next
Create