Managed Service for Apache Kafka® API, REST: User methods
A set of methods for managing Kafka users.
JSON Representation
{
"name": "string",
"clusterId": "string",
"permissions": [
{
"topicName": "string",
"role": "string",
"allowHosts": [
"string"
]
}
]
}
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 |
Methods
Method | Description |
---|---|
create | Creates a Kafka user in the specified cluster. |
delete | Deletes the specified Kafka user. |
get | Returns the specified Kafka user. |
grantPermission | Grants permission to the specified Kafka user. |
list | Retrieves the list of Kafka users in the specified cluster. |
revokePermission | Revokes permission from the specified Kafka user. |
update | Updates the specified Kafka user. |