Command Line Interface (CLI)¶
Provider CLI has been integrated with Apache Airflow CLI airflow command.
Usage: airflow [-h] GROUP_OR_COMMAND ...
Positional Arguments¶
- GROUP_OR_COMMAND
Possible choices: keycloak-auth-manager
Sub-commands¶
keycloak-auth-manager¶
Manage resources used by Keycloak auth manager
airflow keycloak-auth-manager [-h] COMMAND ...
Positional Arguments¶
- COMMAND
Possible choices: create-all, create-permissions, create-resources, create-scopes
Sub-commands¶
create-all¶
Create all entities (scopes, resources and permissions) in Keycloak
airflow keycloak-auth-manager create-all [-h] [--client-id CLIENT_ID] [--password PASSWORD] [--user-realm USER_REALM] [--username USERNAME]
Named Arguments¶
- --client-id
ID of the client used to create resources
Default:
'admin-cli'- --password
Password associated to the user used to create resources
- --user-realm
Realm name where the user used to create resources is
Default:
'master'- --username
Username associated to the user used to create resources
create-permissions¶
Create permissions in Keycloak
airflow keycloak-auth-manager create-permissions [-h] [--client-id CLIENT_ID] [--password PASSWORD] [--user-realm USER_REALM] [--username USERNAME]
Named Arguments¶
- --client-id
ID of the client used to create resources
Default:
'admin-cli'- --password
Password associated to the user used to create resources
- --user-realm
Realm name where the user used to create resources is
Default:
'master'- --username
Username associated to the user used to create resources
create-resources¶
Create resources in Keycloak
airflow keycloak-auth-manager create-resources [-h] [--client-id CLIENT_ID] [--password PASSWORD] [--user-realm USER_REALM] [--username USERNAME]
Named Arguments¶
- --client-id
ID of the client used to create resources
Default:
'admin-cli'- --password
Password associated to the user used to create resources
- --user-realm
Realm name where the user used to create resources is
Default:
'master'- --username
Username associated to the user used to create resources
create-scopes¶
Create scopes in Keycloak
airflow keycloak-auth-manager create-scopes [-h] [--client-id CLIENT_ID] [--password PASSWORD] [--user-realm USER_REALM] [--username USERNAME]
Named Arguments¶
- --client-id
ID of the client used to create resources
Default:
'admin-cli'- --password
Password associated to the user used to create resources
- --user-realm
Realm name where the user used to create resources is
Default:
'master'- --username
Username associated to the user used to create resources