Copilot commented on code in PR #52586:
URL: https://github.com/apache/airflow/pull/52586#discussion_r2175981300
##########
airflow-core/docs/core-concepts/auth-manager/index.rst:
##########
@@ -91,14 +91,27 @@ Some reasons you may want to write a custom auth manager
include:
* You'd like to use an auth manager that leverages an identity provider from
your preferred cloud provider.
* You have a private user management tool that is only available to you or
your organization.
-Authentication related BaseAuthManager methods
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+User representation
+^^^^^^^^^^^^^^^^^^^
+
+: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.
+
+Authentication related methods
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-* ``get_user``: Return the signed-in user.
* ``get_url_login``: Return the URL the user is redirected to for signing in.
+* ``get_url_logout``: Return the URL the user is redirected to when logging
out. This is an optional method,
+ this redirection is usually needed to invalidate resources when logging out,
such as a session.
+* ``serialize_user``: Serialize a user instance to a dict. This dict is the
actual content of the JWT token.
+ It should contain all the information needed to identity the user and make
authorization request.
Review Comment:
Consider replacing 'identity' with 'identify' to improve grammatical
accuracy in the documentation.
```suggestion
It should contain all the information needed to identify the user and make
authorization request.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
