REredpanda-data
Redpanda ACLs

List ACLs

Changed on

List all ACLs. The filter. query string parameters find matching ACLs that meet all specified conditions.

get/v1/acls

Request

  • Base URL
    https://{dataplane_api_url}
  • Auth
    OAuth 2
    Implicit: https://auth.prd.cloud.redpanda.com/oauth/authorize

Query parameters

filter.resource_type'RESOURCE_TYPE_ANY' | 'RESOURCE_TYPE_TOPIC' | 'RESOURCE_TYPE_GROUP' | 'RESOURCE_TYPE_CLUSTER' | 'RESOURCE_TYPE_TRANSACTIONAL_ID' | 'RESOURCE_TYPE_DELEGATION_TOKEN' | 'RESOURCE_TYPE_USER' | 'RESOURCE_TYPE_REGISTRY' | 'RESOURCE_TYPE_SUBJECT'

The type of resource (topic, consumer group, etc.) this ACL targets.

filter.resource_namestring

The name of the resource this ACL targets.

filter.resource_pattern_type'RESOURCE_PATTERN_TYPE_ANY' | 'RESOURCE_PATTERN_TYPE_MATCH' | 'RESOURCE_PATTERN_TYPE_LITERAL' | 'RESOURCE_PATTERN_TYPE_PREFIXED'

The pattern to use for matching the specified resource_name (any, exact match, literal, or prefixed).

filter.principalstring

The user for whom this ACL applies. With the Kafka simple authorizer, you must include the prefix "User:" with the user name.

filter.hoststring

The host address to use for this ACL. To allow a principal access from multiple hosts, you must create an ACL for each host.

filter.operation'OPERATION_ANY' | 'OPERATION_ALL' | 'OPERATION_READ' | 'OPERATION_WRITE' | 'OPERATION_CREATE' | 'OPERATION_DELETE' | 'OPERATION_ALTER' | 'OPERATION_DESCRIBE' | 'OPERATION_CLUSTER_ACTION' | 'OPERATION_DESCRIBE_CONFIGS' | 'OPERATION_ALTER_CONFIGS' | 'OPERATION_IDEMPOTENT_WRITE' | 'OPERATION_CREATE_TOKENS' | 'OPERATION_DESCRIBE_TOKENS'

The operation that is allowed or denied (e.g. READ).

filter.permission_type'PERMISSION_TYPE_ANY' | 'PERMISSION_TYPE_DENY' | 'PERMISSION_TYPE_ALLOW'

Whether the operation should be allowed or denied.

Response

OK

Changes

  • 34fe5c1a0856Revision changes
    • warning

      added the new RESOURCE_TYPE_REGISTRY enum value to the // response property for the response status

    • warning

      added the new RESOURCE_TYPE_SUBJECT enum value to the // response property for the response status

    • info

      added the new enum value RESOURCE_TYPE_REGISTRY to the query request parameter filter.resource_type

    • info

      added the new enum value RESOURCE_TYPE_SUBJECT to the query request parameter filter.resource_type

  • dfa71f9d277eRevision changes
    • breaking

      removed the enum value RESOURCE_TYPE_REGISTRY from the query request parameter filter.resource_type

    • breaking

      removed the enum value RESOURCE_TYPE_SUBJECT from the query request parameter filter.resource_type

    • info

      removed the RESOURCE_TYPE_REGISTRY enum value from the // response property for the response status

    • info

      removed the RESOURCE_TYPE_SUBJECT enum value from the // response property for the response status