ACL (v3)

List ACLs

Generally Available

  • When calling /acls without the principal parameter, service accounts are returned in numeric ID format (e.g., User:12345).
  • To retrieve service accounts in the sa-xxx format, use /acls?principal=UserV2:*.
  • The principal parameter supports both legacy User: format and new UserV2: format for service accounts. Return a list of ACLs that match the search criteria.
get/kafka/v3/clusters/{cluster_id}/acls

Query parameters

resource_type'UNKNOWN' | 'ANY' | 'TOPIC' | 'GROUP' | 'CLUSTER' | 'TRANSACTIONAL_ID' | 'DELEGATION_TOKEN'

The ACL resource type.

resource_namestring

The ACL resource name.

pattern_typestring

The ACL pattern type.

principalstring

The ACL principal. This is the Service Account name or user name. Supports both legacy User: format (numeric IDs) and new UserV2: format (sa-xxx format) for service accounts. Use UserV2:* to retrieve service accounts in the new format.

hoststring

The ACL host.

operationstring

The ACL operation.

permissionstring

The ACL permission.

Response

The list of ACLs.

kindstring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.