Add documentation about Airflow API authentication #48417
Merged
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
vincbeck
requested review from
ephraimbuddy,
pierrejeambrun,
potiuk and
rawwar
as code owners
vincbeck
requested review from
jedcunningham and
pierrejeambrun
and removed request for
pierrejeambrun
vincbeck
force-pushed
the
vincbeck/doc_token
branch
from
9641cb0 to
f067d2e
Compare
pierrejeambrun
approved these changes
Mar 27, 2025
Member
pierrejeambrun
left a comment
pierrejeambrun
left a comment
There was a problem hiding this comment.
Nice thanks, just a few suggestions but non blocking
Co-authored-by: Pierre Jeambrun <pierrejbrun@gmail.com>
pankajkoti
pushed a commit
to astronomer/airflow
that referenced
this pull request
Mar 28, 2025
shubham-pyc
pushed a commit
to shubham-pyc/airflow
that referenced
this pull request
Apr 2, 2025
nailo2c
pushed a commit
to nailo2c/airflow
that referenced
this pull request
Apr 4, 2025
simonprydden
pushed a commit
to simonprydden/airflow
that referenced
this pull request
Apr 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add documentation to explain how to generate a JWT token needed to call Airflow public API. I also enabled the authentication section in the openapi documentation. I added a description in it to help users to authenticate their calls.
As part of this PR, I also mandate auth managers to provide an endpoint to generate a JWT token. This endpoint must be
POST /auth/token. Forcing auth managers to have this specific endpoint will help users to generate a JWT token. Having different endpoints across auth managers would not be consistent and would be confusing for users.^ 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.