Managed Service for Apache Kafka® API, REST: User.get
Returns the specified Kafka user.
To get the list of available Kafka users, make a list request.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/users/{userName}
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the Apache Kafka® cluster the user belongs to. To get the cluster ID, make a list request. The maximum string length in characters is 50. |
userName | Required. Name of the Kafka user to return. To get the name of the user, make a list request. The string length in characters must be 1-63. Value must match the regular expression |
Response
HTTP Code: 200 - OK
{
"name": "string",
"clusterId": "string",
"permissions": [
{
"topicName": "string",
"role": "string",
"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 list request. |
permissions[] | object Set of permissions granted to this user. |
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. |
permissions[]. role |
string Access role type to grant to the user.
|
permissions[]. allowHosts[] |
string Lists hosts allowed for this permission. 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 |