Airflow Summit 2025 is coming October 07-09. Register now to secure your spot!

airflow.providers.fab.auth_manager.models

Submodules

Attributes

Identity

assoc_group_role

assoc_permission_role

assoc_user_role

assoc_user_group

Classes

Action

Represents permission actions such as can_read.

Resource

Represents permission object such as User or Dag.

Role

Represents a user role to which permissions can be assigned.

Permission

Permission pair comprised of an Action + Resource combo.

Group

Represents an Airflow user group.

User

Represents an Airflow user which has roles assigned to it.

RegisterUser

Represents a user registration.

Functions

mapped_column(*args, **kwargs)

add_index_on_ab_user_username_postgres(table, conn, **kw)

add_index_on_ab_register_user_username_postgres(table, ...)

Package Contents

airflow.providers.fab.auth_manager.models.mapped_column(*args, **kwargs)[source]
airflow.providers.fab.auth_manager.models.Identity = None[source]
airflow.providers.fab.auth_manager.models.assoc_group_role[source]
airflow.providers.fab.auth_manager.models.assoc_permission_role[source]
airflow.providers.fab.auth_manager.models.assoc_user_role[source]
airflow.providers.fab.auth_manager.models.assoc_user_group[source]
class airflow.providers.fab.auth_manager.models.Action[source]

Bases: flask_appbuilder.Model

Represents permission actions such as can_read.

__tablename__ = 'ab_permission'[source]
id: sqlalchemy.orm.Mapped[int][source]
name: sqlalchemy.orm.Mapped[str][source]
__repr__()[source]
class airflow.providers.fab.auth_manager.models.Resource[source]

Bases: flask_appbuilder.Model

Represents permission object such as User or Dag.

__tablename__ = 'ab_view_menu'[source]
id: sqlalchemy.orm.Mapped[int][source]
name: sqlalchemy.orm.Mapped[str][source]
__eq__(other)[source]
__neq__(other)[source]
__repr__()[source]
class airflow.providers.fab.auth_manager.models.Role[source]

Bases: flask_appbuilder.Model

Represents a user role to which permissions can be assigned.

__tablename__ = 'ab_role'[source]
id: sqlalchemy.orm.Mapped[int][source]
name: sqlalchemy.orm.Mapped[str][source]
permissions: sqlalchemy.orm.Mapped[list[Permission]][source]
__repr__()[source]
class airflow.providers.fab.auth_manager.models.Permission[source]

Bases: flask_appbuilder.Model

Permission pair comprised of an Action + Resource combo.

__tablename__ = 'ab_permission_view'[source]
__table_args__[source]
id: sqlalchemy.orm.Mapped[int][source]
action_id: sqlalchemy.orm.Mapped[int][source]
action: sqlalchemy.orm.Mapped[Action][source]
resource_id: sqlalchemy.orm.Mapped[int][source]
resource: sqlalchemy.orm.Mapped[Resource][source]
__repr__()[source]
class airflow.providers.fab.auth_manager.models.Group[source]

Bases: flask_appbuilder.Model

Represents an Airflow user group.

__tablename__ = 'ab_group'[source]
id: sqlalchemy.orm.Mapped[int][source]
name: sqlalchemy.orm.Mapped[str][source]
label: sqlalchemy.orm.Mapped[str][source]
description: sqlalchemy.orm.Mapped[str][source]
users: sqlalchemy.orm.Mapped[list[User]][source]
roles: sqlalchemy.orm.Mapped[list[Role]][source]
__repr__()[source]
class airflow.providers.fab.auth_manager.models.User[source]

Bases: flask_appbuilder.Model, airflow.api_fastapi.auth.managers.models.base_user.BaseUser

Represents an Airflow user which has roles assigned to it.

__tablename__ = 'ab_user'[source]
id: sqlalchemy.orm.Mapped[int][source]
first_name: sqlalchemy.orm.Mapped[str][source]
last_name: sqlalchemy.orm.Mapped[str][source]
username: sqlalchemy.orm.Mapped[str][source]
password: sqlalchemy.orm.Mapped[str | None][source]
active: sqlalchemy.orm.Mapped[bool | None][source]
email: sqlalchemy.orm.Mapped[str][source]
last_login: sqlalchemy.orm.Mapped[datetime.datetime | None][source]
login_count: sqlalchemy.orm.Mapped[int | None][source]
fail_login_count: sqlalchemy.orm.Mapped[int | None][source]
roles: sqlalchemy.orm.Mapped[list[Role]][source]
created_on: sqlalchemy.orm.Mapped[datetime.datetime | None][source]
changed_on: sqlalchemy.orm.Mapped[datetime.datetime | None][source]
property created_by_fk: sqlalchemy.Column[source]
property changed_by_fk: sqlalchemy.Column[source]
created_by: sqlalchemy.orm.Mapped[User][source]
changed_by: sqlalchemy.orm.Mapped[User][source]
classmethod get_user_id()[source]
property is_authenticated[source]
property is_active[source]
property is_anonymous[source]
property perms[source]
get_id()[source]
get_name()[source]
get_full_name()[source]
__repr__()[source]
class airflow.providers.fab.auth_manager.models.RegisterUser[source]

Bases: flask_appbuilder.Model

Represents a user registration.

__tablename__ = 'ab_register_user'[source]
id[source]
first_name: sqlalchemy.orm.Mapped[str][source]
last_name: sqlalchemy.orm.Mapped[str][source]
username: sqlalchemy.orm.Mapped[str][source]
password: sqlalchemy.orm.Mapped[str | None][source]
email: sqlalchemy.orm.Mapped[str][source]
registration_date: sqlalchemy.orm.Mapped[datetime.datetime | None][source]
registration_hash: sqlalchemy.orm.Mapped[str | None][source]
airflow.providers.fab.auth_manager.models.add_index_on_ab_user_username_postgres(table, conn, **kw)[source]
airflow.providers.fab.auth_manager.models.add_index_on_ab_register_user_username_postgres(table, conn, **kw)[source]

Was this entry helpful?