Skip to content

Commit 1befb1b

Browse files
committed
Document that GlobusApp always requests openid
This is noted in property documentation for ``scope_requirements``. This is one of a few ways in which users may observe the presence of this scope, but the choices are either to document this on the property or on the top-level class doc. The property is guessed to be more likely to be seen by a user exploring to try to understand their scope requirements. For reference and motivation, see #1359
1 parent c8f27b8 commit 1befb1b

File tree

1 file changed

+7
-0
lines changed
  • src/globus_sdk/globus_app

1 file changed

+7
-0
lines changed

src/globus_sdk/globus_app/app.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -535,6 +535,13 @@ def scope_requirements(self) -> dict[str, list[Scope]]:
535535
536536
Modifying the returned dict will not affect the app's scope requirements.
537537
To add scope requirements, use ``GlobusApp.add_scope_requirements()``.
538+
539+
.. note::
540+
541+
Users may observe that Globus Auth (``'auth.globus.org'``) is always
542+
present, and always maps to the ``openid`` scope, even when the user has
543+
not added this scope. This mapping is expected, as the ``openid`` scope is
544+
needed internally for the functionality provided by ``GlobusApp``.
538545
"""
539546
# Scopes are mutable objects so we return a deepcopy
540547
return copy.deepcopy(self._scope_requirements)

0 commit comments

Comments
 (0)