This action requires the following credentials:

  • user — the username under which the action runs.
  • password — the password for that user.

CreateKafkaACLs — creates a set of ACLs in Kafka.

Request example

securityProtocol: SASL_PLAINTEXT
saslMechanism: PLAIN
acls:
  - topics:
      - example_1
    allow:
      - User:principal_2
      - Group:principal_3
    deny:
      - User:principal_4
      - Group:principal_5
    ops:
      - CREATE
      - READ
      - WRITE
      - DELETE
      - DESCRIBE
      - DESCRIBE_CONFIGS
      - ALTER
    pattern: LITERAL
  - topics:
      - example_6
    allow:
      - User:principal_7
    allow_hosts:
      - 127.0.0.1
    deny:
      - User:principal_8
    deny_hosts:
      - 127.0.0.1
    ops:
      - CREATE
    pattern: LITERAL

Request specification

NameRequiredDescriptionPossible valuesDefault value
securityProtocolYesProtocol for connecting to Kafka. For more information, see the Kafka documentationPLAINTEXT, SASL_PLAINTEXT, SASL_SSL-
saslMechanismNoSASL authentication mechanism. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see the Kafka documentationPLAIN, SCRAM-SHA-256, SCRAM-SHA-512-
aclsYesSet of ACLs to create--
acls.opsYesList of operations to which the rule appliesList of possible operations-
acls.patternYesPattern typeList of possible patterns-
acls.topicsNoList of topic names to which the rule applies--
acls.groupsNoList of group names to which the rule applies--
acls.transactional_idsNoList of transaction IDs to which the rule applies--
acls.tokensNoList of tokens to which the rule applies--
acls.allowNoList of principals (users or groups) allowed by the rule--
acls.denyNoList of principals (users or groups) denied by the rule--
acls.hostsNoList of hosts for which the operation is allowed--
acls.deny_hostsNoList of hosts for which the operation is denied--

List of possible patterns

  • ANY.
  • MATCH.
  • LITERAL.
  • PREFIXED.

List of possible operations

For more information, see the Kafka documentation.

Topics:

  • ALL.
  • ALTER.
  • ALTER_CONFIGS.
  • CREATE.
  • DELETE.
  • DESCRIBE.
  • DESCRIBE_CONFIGS.
  • READ.
  • WRITE.

Group:

  • ALL.
  • DELETE.
  • DESCRIBE.
  • READ.

TransactionalID:

  • ALL.
  • DESCRIBE.
  • WRITE.

Tokens:

  • DESCRIBE.