.. _cli-confluent-acl:

=============
confluent acl
=============

Description
-----------
Specify an ACL for a service.


Usage
-----

.. sourcecode:: bash

   confluent acl <service> [<argument>]


Options
-------

===================================  =======  ==============================================
Name, shorthand                      Default  Description
===================================  =======  ==============================================
``-h``, ``--help``                            Print usage information.
``--add``                                     Add ACLs.
``--remove``                                  Remove ACLs.
``--list``                                    List all current ACLs.
``--config <file>``                           Required: the ACL properties file.
``-o, --operation <operation>``               Operation that is being authorized.
``-p, --principal <principal>``               Principal that the ACL is being applied to.
``-s, --subject <subject>``                   Subject that the ACL is applied to. Only
                                              applies to ``SUBJECT`` operations.
``-t, --topic <topic>``                       Topic that the ACL is being applied to. The
                                              corresponding subjects are ``topic-key`` and
                                              ``topic-value``. Only applies to SUBJECT
                                              operations.
===================================  =======  ==============================================


Positional arguments
--------------------

===============  =======  ====================================================
Name, shorthand  Default  Description
===============  =======  ====================================================
``<file>``                Required: The properties filename.
``<operation>``           The name of the operation. Valid operations names
                          are:

                          | SUBJECT_READ
                          | SUBJECT_WRITE
                          | SUBJECT_DELETE
                          | SUBJECT_COMPATIBILITY_READ
                          | SUBJECT_COMPATIBILITY_WRITE
``<principal>``           The name of the principal. Use an asterisk ``*`` to
                          apply to all principals.
``<service>``             The service that the ACL is applied to. Schema
                          Registry (``schema-registry``) is currently the
                          only supported service for ACL.
``<subject>``             The name of the subject. Use an asterisk ``*`` to
                          apply to all subjects.
``<topic>``               The name of the topic. Use an asterisk ``*`` to
                          apply to all topics.

===============  =======  ====================================================