Create ACLs

POST /security/acls

Create new ACL rules.

application/json

Body Required

  • principal string Required

    The name of the principal, for example, User:alice or RedpandaRole:admin. Use "*" to represent a wildcard.

  • resource string Required

    The name of the resource. Use "*" to represent a wildcard.

  • resource_type string Required

    The type of resource being secured.

    Values are REGISTRY or SUBJECT.

  • pattern_type string Required

    Pattern match type for the resource. Only applies when resource_type is SUBJECT.

    Values are LITERAL or PREFIXED.

  • host string Required

    Originating host for which this rule applies. Use "*" to represent a wildcard.

  • operation string Required

    The operation to allow or deny.

    Values are ALL, READ, WRITE, DELETE, DESCRIBE, DESCRIBE_CONFIGS, or ALTER_CONFIGS.

  • permission string Required

    Specifies whether the operation is allowed or denied.

    Values are ALLOW or DENY.

Responses

  • 201

    ACLs created

  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
    • error_code integer
    • message string
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • error_code integer
    • message string
  • 403 application/json

    Forbidden

    Hide response attributes Show response attributes object
    • error_code integer
    • message string
  • 500 application/json

    Internal Server Error

    Hide response attributes Show response attributes object
    • error_code integer
    • message string
POST /security/acls 
curl \
 --request POST 'http://localhost:8081/security/acls' \
 --header "Content-Type: application/json" \
 --data '[{"principal":"string","resource":"string","resource_type":"REGISTRY","pattern_type":"LITERAL","host":"string","operation":"ALL","permission":"ALLOW"}]'
Request examples 
[
  {
    "principal": "string",
    "resource": "string",
    "resource_type": "REGISTRY",
    "pattern_type": "LITERAL",
    "host": "string",
    "operation": "ALL",
    "permission": "ALLOW"
  }
]
Response examples (400) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (401) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (403) 
{
  "error_code": 42,
  "message": "string"
}
Response examples (500) 
{
  "error_code": 42,
  "message": "string"
}