airflow.providers.fab.auth_manager.api_fastapi.routes.roles¶

Attributes¶

roles_router

Functions¶

`create_role`(body)	Create a new role (actions can be empty).
`get_roles`([order_by, limit, offset])	List roles with pagination and ordering.
`delete_role`([name])	Delete an existing role.
`get_role`([name])	Get an existing role.
`patch_role`(body[, name, update_mask])	Update an existing role.
`get_permissions`([limit, offset])	List all action-resource (permission) pairs.

Module Contents¶

airflow.providers.fab.auth_manager.api_fastapi.routes.roles.roles_router[source]¶

airflow.providers.fab.auth_manager.api_fastapi.routes.roles.create_role(body)[source]¶

Create a new role (actions can be empty).

airflow.providers.fab.auth_manager.api_fastapi.routes.roles.get_roles(order_by=Query('name', description="Field to order by. Prefix with '-' for descending."), limit=Depends(get_effective_limit()), offset=Query(0, ge=0, description='Number of items to skip before starting to collect results.'))[source]¶

List roles with pagination and ordering.

airflow.providers.fab.auth_manager.api_fastapi.routes.roles.delete_role(name=Path(..., min_length=1))[source]¶

Delete an existing role.

airflow.providers.fab.auth_manager.api_fastapi.routes.roles.get_role(name=Path(..., min_length=1))[source]¶

Get an existing role.

airflow.providers.fab.auth_manager.api_fastapi.routes.roles.patch_role(body, name=Path(..., min_length=1), update_mask=Query(None, description='Comma-separated list of fields to update'))[source]¶

Update an existing role.

airflow.providers.fab.auth_manager.api_fastapi.routes.roles.get_permissions(limit=Query(100), offset=Query(0))[source]¶

List all action-resource (permission) pairs.