Access Control¶
Access Control of Airflow Webserver UI is handled by Flask AppBuilder (FAB). Please read its related security document regarding its security model.
Default Roles¶
Airflow ships with a set of roles by default: Admin, User, Op, Viewer, and Public.
Only Admin users could configure/alter the permissions for other roles. But it is not recommended
that Admin users alter these default roles in any way by removing
or adding permissions to these roles.
Admin¶
Admin users have all possible permissions, including granting or revoking permissions from
other users.
Public¶
Public users (anonymous) don't have any permissions.
Viewer¶
Viewer users have limited viewer permissions
VIEWER_PERMISSIONS = [
(permissions.ACTION_CAN_READ, permissions.RESOURCE_DAG),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_DAG_CODE),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_DAG_RUN),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_IMPORT_ERROR),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_AUDIT_LOG),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_JOB),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_PLUGIN),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_SLA_MISS),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_TASK_INSTANCE),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_TASK_LOG),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_XCOM),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_WEBSITE),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_BROWSE_MENU),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_DAG_RUN),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_DOCS_LINK),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_DOCS_MENU),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_JOB),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_AUDIT_LOG),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_PLUGIN),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_SLA_MISS),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_TASK_INSTANCE),
(permissions.ACTION_CAN_THIS_FORM_GET, permissions.RESOURCE_RESET_MY_PASSWORD_VIEW),
(permissions.ACTION_CAN_THIS_FORM_POST, permissions.RESOURCE_RESET_MY_PASSWORD_VIEW),
(permissions.ACTION_RESETMYPASSWORD, permissions.RESOURCE_USER_DB_MODELVIEW),
(permissions.ACTION_CAN_THIS_FORM_GET, permissions.RESOURCE_USERINFO_EDIT_VIEW),
(permissions.ACTION_CAN_THIS_FORM_POST, permissions.RESOURCE_USERINFO_EDIT_VIEW),
(permissions.ACTION_USERINFOEDIT, permissions.RESOURCE_USER_DB_MODELVIEW),
(permissions.ACTION_CAN_USERINFO, permissions.RESOURCE_USER_DB_MODELVIEW),
(permissions.ACTION_CAN_USERINFO, permissions.RESOURCE_USER_OID_MODELVIEW),
(permissions.ACTION_CAN_USERINFO, permissions.RESOURCE_USER_LDAP_MODELVIEW),
(permissions.ACTION_CAN_USERINFO, permissions.RESOURCE_USER_OAUTH_MODELVIEW),
(permissions.ACTION_CAN_USERINFO, permissions.RESOURCE_USER_REMOTEUSER_MODELVIEW),
]
on limited web views.
User¶
User users have Viewer permissions plus additional user permissions
USER_PERMISSIONS = [
(permissions.ACTION_CAN_EDIT, permissions.RESOURCE_DAG),
(permissions.ACTION_CAN_DELETE, permissions.RESOURCE_DAG),
(permissions.ACTION_CAN_CREATE, permissions.RESOURCE_TASK_INSTANCE),
(permissions.ACTION_CAN_EDIT, permissions.RESOURCE_TASK_INSTANCE),
(permissions.ACTION_CAN_DELETE, permissions.RESOURCE_TASK_INSTANCE),
(permissions.ACTION_CAN_CREATE, permissions.RESOURCE_DAG_RUN),
(permissions.ACTION_CAN_EDIT, permissions.RESOURCE_DAG_RUN),
(permissions.ACTION_CAN_DELETE, permissions.RESOURCE_DAG_RUN),
]
on User web views which is the same as Viewer web views.
Op¶
Op users have User permissions plus additional op permissions
OP_PERMISSIONS = [
(permissions.ACTION_CAN_READ, permissions.RESOURCE_CONFIG),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_ADMIN_MENU),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_CONNECTION),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_POOL),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_VARIABLE),
(permissions.ACTION_CAN_ACCESS_MENU, permissions.RESOURCE_XCOM),
(permissions.ACTION_CAN_CREATE, permissions.RESOURCE_CONNECTION),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_CONNECTION),
(permissions.ACTION_CAN_EDIT, permissions.RESOURCE_CONNECTION),
(permissions.ACTION_CAN_DELETE, permissions.RESOURCE_CONNECTION),
(permissions.ACTION_CAN_CREATE, permissions.RESOURCE_POOL),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_POOL),
(permissions.ACTION_CAN_EDIT, permissions.RESOURCE_POOL),
(permissions.ACTION_CAN_DELETE, permissions.RESOURCE_POOL),
(permissions.ACTION_CAN_CREATE, permissions.RESOURCE_VARIABLE),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_VARIABLE),
(permissions.ACTION_CAN_EDIT, permissions.RESOURCE_VARIABLE),
(permissions.ACTION_CAN_DELETE, permissions.RESOURCE_VARIABLE),
(permissions.ACTION_CAN_DELETE, permissions.RESOURCE_XCOM),
]
on User web views.
Custom Roles¶
DAG Level Role¶
Admin can create a set of roles which are only allowed to view a certain set of dags. This is called DAG level access. Each dag defined in the dag model table
is treated as a View which has two permissions associated with it (can_read and can_edit. can_dag_read and can_dag_edit are deprecated since 2.0.0).
There is a special view called DAGs (it was called all_dags in versions 1.10.*) which
allows the role to access all the dags. The default Admin, Viewer, User, Op roles can all access DAGs view.
The image shows the creation of a role which can only write to
example_python_operator. You can also create roles via the CLI
using the airflow roles create command, e.g.:
airflow roles create Role1 Role2
And we could assign the given role to a new user using the airflow
users add-role CLI command.
Permissions¶
Resource-Based permissions¶
Starting with version 2.0, permissions are based on individual resources and a small subset of actions on those
resources. Resources match standard Airflow concepts, such as Dag, DagRun, Task, and
Connection. Actions include can_create, can_read, can_edit, and can_delete.
Permissions (each consistent of a resource + action pair) are then added to roles.
To access an endpoint, the user needs all permissions assigned to that endpoint
There are five default roles: Public, Viewer, User, Op, and Admin. Each one has the permissions of the preceding role, as well as additional permissions.
DAG-level permissions¶
For DAG-level permissions exclusively, access can be controlled at the level of all DAGs or individual DAG objects. This includes DAGs.can_create, DAGs.can_read, DAGs.can_edit, and DAGs.can_delete. When these permissions are listed, access is granted to users who either have the listed permission or the same permission for the specific DAG being acted upon. For individual DAGs, the resource name is DAG: + the DAG ID.
For example, if a user is trying to view DAG information for the example_dag_id, and the endpoint requires DAGs.can_read access, access will be granted if the user has either DAGs.can_read or DAG:example_dag_id.can_read access.
Stable API Permissions |
|||
|---|---|---|---|
Endpoint |
Method |
Permissions |
Minimum Role |
/config |
GET |
Configurations.can_read |
Op |
/connections |
GET |
Connections.can_read |
Op |
/connections |
POST |
Connections.can_create |
Op |
/connections/{connection_id} |
DELETE |
Connections.can_delete |
Op |
/connections/{connection_id} |
PATCH |
Connections.can_edit |
Op |
/connections/{connection_id} |
GET |
Connections.can_read |
Op |
/dagSources/{file_token} |
GET |
DAG Code.can_read |
Viewer |
/dags |
GET |
DAGs.can_read |
Viewer |
/dags/{dag_id} |
GET |
DAGs.can_read |
Viewer |
/dags/{dag_id} |
PATCH |
DAGs.can_edit |
User |
/dags/{dag_id}/clearTaskInstances |
POST |
DAGs.can_read, DAG Runs.can_read, Task Instances.can_edit |
User |
/dags/{dag_id}/details |
GET |
DAGs.can_read |
Viewer |
/dags/{dag_id}/tasks |
GET |
DAGs.can_read, Task Instances.can_read |
Viewer |
/dags/{dag_id}/tasks/{task_id} |
GET |
DAGs.can_read, Task Instances.can_read |
Viewer |
/dags/{dag_id}/dagRuns |
GET |
DAGs.can_read, DAG Runs.can_read |
Viewer |
/dags/{dag_id}/dagRuns |
POST |
DAGs.can_edit, DAG Runs.can_create |
User |
/dags/{dag_id}/dagRuns/{dag_run_id} |
DELETE |
DAGs.can_read, DAG Runs.can_delete |
User |
/dags/{dag_id}/dagRuns/{dag_run_id} |
GET |
DAGs.can_read, DAG Runs.can_read |
Viewer |
/dags/~/dagRuns/list |
POST |
DAGs.can_read, DAG Runs.can_read |
Viewer |
/eventLogs |
GET |
Audit Logs.can_read |
Viewer |
/eventLogs/{event_log_id} |
GET |
Audit Logs.can_read |
Viewer |
/importErrors |
GET |
ImportError.can_read |
Viewer |
/importErrors/{import_error_id} |
GET |
ImportError.can_read |
Viewer |
/health |
GET |
None |
Public |
/version |
GET |
None |
Public |
/pools |
GET |
Pool.can_read |
Op |
/pools |
POST |
Pool.can_create |
Op |
/pools/{pool_name} |
DELETE |
Pool.can_delete |
Op |
/pools/{pool_name} |
GET |
Pool.can_read |
Op |
/pools/{pool_name} |
PATCH |
Pool.can_edit |
Op |
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances |
GET |
DAGs.can_read, DAG Runs.can_read, Task Instances.can_read |
Viewer |
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} |
GET |
DAGs.can_read, DAG Runs.can_read, Task Instances.can_read |
Viewer |
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links |
GET |
DAGs.can_read, DAG Runs.can_read, Task Instances.can_read |
Viewer |
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number} |
GET |
DAGs.can_read, DAG Runs.can_read, Task Instances.can_read |
Viewer |
/dags/~/dagRuns/~/taskInstances/list |
POST |
DAGs.can_read, DAG Runs.can_read, Task Instances.can_read |
Viewer |
/variables |
GET |
Variables.can_read |
Op |
/variables |
POST |
Variables.can_create |
Op |
/variables/{variable_key} |
DELETE |
Variables.can_delete |
Op |
/variables/{variable_key} |
GET |
Variables.can_read |
Op |
/variables/{variable_key} |
PATCH |
Variables.can_edit |
Op |
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries |
GET |
DAGs.can_read, DAG Runs.can_read, Task Instances.can_read, XComs.can_read |
Viewer |
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key} |
GET |
DAGs.can_read, DAG Runs.can_read, Task Instances.can_read, XComs.can_read |
Viewer |
Website Permissions |
||
|---|---|---|
Action |
Permissions |
Minimum Role |
Access homepage |
Website.can_read |
Viewer |
Get DAG stats |
Dags.can_read, DAG Runs.can_read |
Viewer |
Get Task stats |
Dags.can_read, DAG Runs.can_read, Task Instances.can_read |
Viewer |
Get last DAG runs |
Dags.can_read, DAG Runs.can_read |
Viewer |
Get DAG code |
Dags.can_read, DAG Code.can_read |
Viewer |
Get DAG details |
Dags.can_read, DAG Runs.can_read |
Viewer |
Get rendered DAG |
DAGs.can_read, Task Instances.can_read |
Viewer |
Get Logs with metadata |
DAGs.can_read, Task Instances.can_read, Task Logs.can_read |
Viewer |
Get Log |
DAGs.can_read, Task Instances.can_read, Task Logs.can_read |
Viewer |
Redirect to external Log |
DAGs.can_read, Task Instances.can_read, Task Logs.can_read |
Viewer |
Get Task |
DAGs.can_read, Task Instances.can_read |
Viewer |
Get XCom |
DAGs.can_read, Task Instances.can_read, XComs.can_read |
Viewer |
Triggers Task Instance |
DAGs.can_read, Task Instances.can_create |
User |
Delete DAG |
DAGs.can_delete |
User |
Trigger DAG run |
Dags.can_edit, DAG Runs.can_create |
User |
Clear DAG |
DAGs.can_read, Task Instances.can_delete |
User |
Clear DAG Run |
DAGs.can_read, Task Instances.can_delete |
User |
Mark DAG as blocked |
Dags.can_read, DAG Runs.can_read |
User |
Mark DAG Run as failed |
Dags.can_read, DAG Runs.can_edit |
User |
Mark DAG Run as success |
Dags.can_read, DAG Runs.can_edit |
User |
Mark Task as failed |
DAGs.can_read, Task Instances.can_edit |
User |
Mark Task as success |
DAGs.can_read, Task Instances.can_edit |
User |
Get DAG as tree |
DAGs.can_read, Task Instances.can_read, Task Logs.can_read |
Viewer |
Get DAG as graph |
DAGs.can_read, Task Instances.can_read, Task Logs.can_read |
Viewer |
Get DAG as duration graph |
DAGs.can_read, Task Instances.can_read |
Viewer |
Show all tries |
DAGs.can_read, Task Instances.can_read |
Viewer |
Show landing times |
DAGs.can_read, Task Instances.can_read |
Viewer |
Toggle DAG paused status |
DAGs.can_edit |
User |
Refresh DAG |
DAGs.can_edit |
User |
Refresh all DAGs |
DAGs.can_edit |
User |
Show Gantt Chart |
DAGs.can_read, Task Instances.can_read |
Viewer |
Get external links |
DAGs.can_read, Task Instances.can_read |
Viewer |
Show Task Instances |
DAGs.can_read, Task Instances.can_read |
Viewer |
Show Configs |
Configurations.can_read |
Viewer |
Delete multiple records |
DAGs.can_edit |
User |
Set Task Instance as running |
DAGs.can_edit |
User |
Set Task Instance as failed |
DAGs.can_edit |
User |
Set Task Instance as success |
DAGs.can_edit |
User |
Set Task Instance as up_for_retry |
DAGs.can_edit |
User |
Autocomplete |
DAGs.can_read |
Viewer |
List Logs |
Audit Logs.can_read |
Viewer |
List Jobs |
Jobs.can_read |
Viewer |
List SLA Misses |
SLA Misses.can_read |
Viewer |
List Plugins |
Plugins.can_read |
Viewer |
List Task Reschedules |
Task Reschedules.can_read |
Admin |