Update auth manager documentation to reflect Airflow 3 changes #52586
+35
−9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 tasks
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the auth manager documentation to reflect changes introduced in Airflow 3. Key changes include the addition of a "User representation" section, updated authentication and authorization methods, and new optional methods for enhanced functionality.
Co-authored-by: Copilot <[email protected]>
| :class:`~airflow.api_fastapi.auth.managers.base_auth_manager.BaseAuthManager` defines an authentication manager, | ||
| parameterized by a user class T representing the authenticated user type. | ||
| Auth manager implementations (subclasses of :class:`~airflow.api_fastapi.auth.managers.base_auth_manager.BaseAuthManager`) | ||
| should specify the associated concrete user type. Each auth manager has its own user type definition. |
There was a problem hiding this comment.
maybe worth noting that the concrete user type should be a subclass of airflow.api_fastapi.auth.managers.models.base_user.BaseUser
|
|
||
| JWT token management by auth managers | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| The auth manager is responsible for creating the JWT token needed to interact with Airflow public API. | ||
| To achieve this, the auth manager **must** provide an endpoint to create this JWT token. This endpoint must be | ||
| available at ``POST /auth/token`` | ||
| To achieve this, the auth manager **must** provide an endpoint to create this JWT token. This endpoint is usually |
There was a problem hiding this comment.
If the token generation endpoint path doesn't strictly have to be at /auth/token, it might be worth clarifying if what dictates how Airflow determines which custom auth manager endpoint to use for token generation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related #51971.
Auth manager doc has not been updated to reflect Airflow 3 status.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in airflow-core/newsfragments.