Kafka ACL

Operations related to Kafka Access Control Lists.

Get a list of Kafka ACLs

Retrieve a list of Kafka ACLs currently in the given cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
Responses
200

Successfully returned a JSON list of Kafka ACLs

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

get/provisioning/v1/{clusterId}/kafka/acls
Request samples
Response samples
application/json
{
  • "acls": [
    ]
}

Create a Kafka ACL

Create a new Kafka ACL in the given cluster

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
Request Body schema: application/json
principal
string

Valid values must start with "User:" including the wildcard, e.g., "User:*"

host
string

It takes any string including the wildcard "*"

resourceType
string

Valid values for resourceType: "CLUSTER", "TOPIC", "GROUP", "DELEGATION_TOKEN", "TRANSACTIONAL_ID"

resourceName
string

It takes any string including the wildcard "*"

operation
string

Valid values for operation: "ALL", "READ", "WRITE", "CREATE", "DELETE", "ALTER", "DESCRIBE", "CLUSTER_ACTION", "DESCRIBE_CONFIGS", "ALTER_CONFIGS", "IDEMPOTENT_WRITE"

permissionType
string

Valid values for permissionType: "ALLOW", "DENY"

patternType
string

Valid values for patternType: "LITERAL", "PREFIXED"

Responses
200

Kafka ACL successfully created

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

post/provisioning/v1/{clusterId}/kafka/acls
Request samples
application/json
{
  • "principal": "User:test",
  • "host": "*",
  • "resourceType": "CLUSTER",
  • "resourceName": "kafka-cluster",
  • "operation": "DESCRIBE",
  • "permissionType": "ALLOW",
  • "patternType": "LITERAL"
}
Response samples
application/json
{
  • "message": "Kafka ACL (principal=User:*, host=*, resourceType=topic, resourceName=*, operation=alter, permissionType=deny, patternType=literal) is created."
}

Delete a Kafka ACL

Delete Kafka ACLs in the given cluster that fit the filter specified in the request body

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
Request Body schema: application/json
principal
string

Valid values must start with "User:" including the wildcard, e.g., "User:*"

host
string

It takes any string including the wildcard "*"

resourceType
string

Valid values for resourceType: "CLUSTER", "TOPIC", "GROUP", "DELEGATION_TOKEN", "TRANSACTIONAL_ID", "ANY"

resourceName
string

It takes any string including the wildcard "*"

operation
string

Valid values for operation: "ANY", "ALL", "READ", "WRITE", "CREATE", "DELETE", "ALTER", "DESCRIBE", "CLUSTER_ACTION", "DESCRIBE_CONFIGS", "ALTER_CONFIGS", "IDEMPOTENT_WRITE"

permissionType
string

Valid values for permissionType: "ALLOW", "DENY", "ANY"

patternType
string

Valid values for patternType: "LITERAL", "PREFIXED", "MATCH", "ANY"

Responses
200

Kafka ACL successfully deleted

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

delete/provisioning/v1/{clusterId}/kafka/acls
Request samples
application/json
{
  • "principal": "User:test",
  • "host": "*",
  • "resourceType": "CLUSTER",
  • "resourceName": "kafka-cluster",
  • "operation": "DESCRIBE",
  • "permissionType": "ALLOW",
  • "patternType": "LITERAL"
}
Response samples
application/json
{
  • "message": "Kafka ACL (principal=User:*, host=*, resourceType=topic, resourceName=*, operation=alter, permissionType=deny, patternType=literal) is deleted."
}

Search Kafka ACL

Search Kafka ACLs in the given cluster

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
Request Body schema: application/json
principal
string

(Optional) If supplied, valid values must start with "User:" including the wildcard, e.g., "User:*"

host
string

(Optional) If supplied, it takes any string including the wildcard "*"

resourceType
string

(Optional) If supplied, valid values for resourceType: "CLUSTER", "TOPIC", "GROUP", "DELEGATION_TOKEN", "TRANSACTIONAL_ID", "ANY"

resourceName
string

(Optional) If supplied, it takes any string including the wildcard "*"

operation
string

(Optional) If supplied, valid values for operation: "ANY", "ALL", "READ", "WRITE", "CREATE", "DELETE", "ALTER", "DESCRIBE", "CLUSTER_ACTION", "DESCRIBE_CONFIGS", "ALTER_CONFIGS", "IDEMPOTENT_WRITE"

permissionType
string

(Optional) If supplied, valid values for permissionType: "ALLOW", "DENY", "ANY"

patternType
string

(Optional) If supplied, valid values for patternType: "LITERAL", "PREFIXED", "MATCH", "ANY"

Responses
200

Successfully returned a JSON list of Kafka ACLs

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

post/provisioning/v1/{clusterId}/kafka/acls/searches
Request samples
application/json
{
  • "principal": "User:test",
  • "host": "*",
  • "resourceType": "CLUSTER",
  • "resourceName": "kafka-cluster",
  • "operation": "DESCRIBE",
  • "permissionType": "ALLOW",
  • "patternType": "LITERAL"
}
Response samples
application/json
{
  • "acls": [
    ]
}