Consent forest sc 30764

changelog.d/20240401_164617_derek_consent_forest_sc_30764.rst

@@ -0,0 +1,7 @@
+
+Added
+~~~~~
+
+- Added a new AuthClient method ``get_consents`` and supporting local data objects.
+  These allows a client to poll and interact with the current Globus Auth consent state
+  of a particular identity rooted at their client. (:pr:`NUMBER`)

docs/services/auth.rst

@@ -52,6 +52,15 @@ batching, and other functionality.
    :exclude-members: __dict__,__weakref__
    :show-inheritance:
 
+.. autoclass:: ConsentForest
+   :members:
+
+.. autoclass:: ConsentTree
+   :members:
+
+.. autoclass:: Consent
+   :members:
+
 .. autoclass:: DependentScopeSpec
 
 Auth Responses
@@ -65,10 +74,21 @@ Auth Responses
    :members:
    :show-inheritance:
 
+.. autoclass:: GetConsentsResponse
+   :members:
+   :show-inheritance:
+
 .. autoclass:: GetIdentitiesResponse
    :members:
    :show-inheritance:
 
+Errors
+------
+
+.. autoexception:: AuthAPIError
+
+.. autoexception:: ConsentParseError
+
 OAuth2 Flow Managers
 --------------------
 

src/globus_sdk/__init__.py

@@ -57,7 +57,12 @@ def _force_eager_imports() -> None:
         "NativeAppAuthClient",
         "ConfidentialAppAuthClient",
         "AuthAPIError",
+        "ConsentParseError",
+        "Consent",
+        "ConsentTree",
+        "ConsentForest",
         "IdentityMap",
+        "GetConsentsResponse",
         "GetIdentitiesResponse",
         "OAuthDependentTokenResponse",
         "OAuthTokenResponse",
@@ -171,7 +176,12 @@ def _force_eager_imports() -> None:
     from .services.auth import NativeAppAuthClient
     from .services.auth import ConfidentialAppAuthClient
     from .services.auth import AuthAPIError
+    from .services.auth import ConsentParseError
+    from .services.auth import Consent
+    from .services.auth import ConsentTree
+    from .services.auth import ConsentForest
     from .services.auth import IdentityMap
+    from .services.auth import GetConsentsResponse
     from .services.auth import GetIdentitiesResponse
     from .services.auth import OAuthDependentTokenResponse
     from .services.auth import OAuthTokenResponse
@@ -289,6 +299,10 @@ def __getattr__(name: str) -> t.Any:
     "CollectionDocument",
     "CollectionPolicies",
     "ConfidentialAppAuthClient",
+    "Consent",
+    "ConsentForest",
+    "ConsentParseError",
+    "ConsentTree",
     "DeleteData",
     "DependentScopeSpec",
     "EndpointDocument",
@@ -298,6 +312,7 @@ def __getattr__(name: str) -> t.Any:
     "GCSAPIError",
     "GCSClient",
     "GCSRoleDocument",
+    "GetConsentsResponse",
     "GetIdentitiesResponse",
     "GlobusAPIError",
     "GlobusConnectPersonalOwnerInfo",

src/globus_sdk/_generate_init.py

@@ -117,9 +117,14 @@ def __getattr__(name: str) -> t.Any:
             "ConfidentialAppAuthClient",
             # errors
             "AuthAPIError",
+            "ConsentParseError",
             # high-level helpers
+            "Consent",
+            "ConsentTree",
+            "ConsentForest",
             "IdentityMap",
             # responses
+            "GetConsentsResponse",
             "GetIdentitiesResponse",
             "OAuthDependentTokenResponse",
             "OAuthTokenResponse",

src/globus_sdk/_testing/data/auth/get_consents.py

@@ -0,0 +1,49 @@
+from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+
+_DATA_ACCESS = (
+    "https://auth.globus.org/scopes/542a86fc-1766-450d-841f-065488a2ec01/data_access"
+)
+
+RESPONSES = ResponseSet(
+    default=RegisteredResponse(
+        service="auth",
+        path="/v2/api/identities/8ca28797-3541-4a5d-a264-05b00f91e608/consents",
+        json={
+            "consents": [
+                {
+                    "created": "2022-09-21T17:10:14.270581+00:00",
+                    "id": 142632,
+                    "status": "approved",
+                    "updated": "2022-09-21T17:10:14.270581+00:00",
+                    "allows_refresh": True,
+                    "dependency_path": [142632],
+                    "scope_name": "urn:globus:auth:scope:transfer.api.globus.org:all",
+                    "atomically_revocable": False,
+                    "effective_identity": "8ca28797-3541-4a5d-a264-05b00f91e608",
+                    "auto_approved": False,
+                    "last_used": "2024-03-18T17:34:04.719126+00:00",
+                    "scope": "89ecabba-4acf-4e2e-a98d-ce592ccc2818",
+                    "client": "065db752-2f43-4fe1-a633-2ee68c9da889",
+                },
+                {
+                    "created": "2024-03-18T17:32:51.496893+00:00",
+                    "id": 433892,
+                    "status": "approved",
+                    "updated": "2024-03-18T17:32:51.496893+00:00",
+                    "allows_refresh": True,
+                    "dependency_path": [142632, 433892],
+                    "scope_name": _DATA_ACCESS,
+                    "atomically_revocable": True,
+                    "effective_identity": "8ca28797-3541-4a5d-a264-05b00f91e608",
+                    "auto_approved": False,
+                    "last_used": "2024-03-18T17:33:05.178254+00:00",
+                    "scope": "fe334c19-4fe6-4d03-ac73-8992beb231b6",
+                    "client": "2fbdda78-a599-4cb5-ac3d-1fbcfbc6a754",
+                },
+            ]
+        },
+        metadata={
+            "identity_id": "8ca28797-3541-4a5d-a264-05b00f91e608",
+        },
+    ),
+)

src/globus_sdk/scopes/data.py

@@ -59,6 +59,7 @@ class _AuthScopesBuilder(ScopeBuilder):
         "view_authentications",
         "view_clients",
         "view_clients_and_scopes",
+        "view_consents",
         "view_identities",
         "view_identity_set",
     ],

src/globus_sdk/services/auth/__init__.py

@@ -4,14 +4,16 @@
     ConfidentialAppAuthClient,
     NativeAppAuthClient,
 )
+from .consents import Consent, ConsentForest, ConsentTree
 from .data import DependentScopeSpec
-from .errors import AuthAPIError
+from .errors import AuthAPIError, ConsentParseError
 from .flow_managers import (
     GlobusAuthorizationCodeFlowManager,
     GlobusNativeAppFlowManager,
 )
 from .identity_map import IdentityMap
 from .response import (
+    GetConsentsResponse,
     GetIdentitiesResponse,
     OAuthDependentTokenResponse,
     OAuthTokenResponse,
@@ -25,13 +27,18 @@
     "ConfidentialAppAuthClient",
     # errors
     "AuthAPIError",
+    "ConsentParseError",
     # high-level helpers
-    "IdentityMap",
+    "Consent",
+    "ConsentTree",
+    "ConsentForest",
     "DependentScopeSpec",
+    "IdentityMap",
     # flow managers
     "GlobusNativeAppFlowManager",
     "GlobusAuthorizationCodeFlowManager",
     # responses
+    "GetConsentsResponse",
     "GetIdentitiesResponse",
     "OAuthDependentTokenResponse",
     "OAuthTokenResponse",

src/globus_sdk/services/auth/client/service_client.py

@@ -19,6 +19,7 @@
 from ..response import (
     GetClientCredentialsResponse,
     GetClientsResponse,
+    GetConsentsResponse,
     GetIdentitiesResponse,
     GetIdentityProvidersResponse,
     GetPoliciesResponse,
@@ -1789,7 +1790,7 @@ def delete_scope(self, scope_id: UUIDLike) -> GlobusHTTPResponse:
 
                     >>> ac = globus_sdk.AuthClient(...)
                     >>> scope_id = ...
-                    >>> r = ac.delete_policy(scope_id)
+                    >>> r = ac.delete_scope(scope_id)
 
             .. tab-item:: Example Response Data
 
@@ -1803,3 +1804,31 @@ def delete_scope(self, scope_id: UUIDLike) -> GlobusHTTPResponse:
                     :ref: auth/reference/#delete_scope
         """
         return self.delete(f"/v2/api/scopes/{scope_id}")
+
+    def get_consents(self, identity_id: UUIDLike) -> GetConsentsResponse:
+        """
+        Look up consents for a user. Requires the ``view_consents`` scope.
+
+        :param identity_id: The ID of the identity to look up consents for
+
+        .. tab-set::
+
+            .. tab-item:: Example Usage
+
+                .. code-block:: pycon
+
+                    >>> ac = globus_sdk.AuthClient(...)
+                    >>> identity_id = ...
+                    >>> forest = ac.get_consents(identity_id).to_forest()
+
+            .. tab-item:: Example Response Data
+
+                .. expandtestfixture:: auth.get_consents
+
+            .. tab-item:: API Info
+
+                ``GET /v2/api/identities/{identity_id}/consents``
+        """
+        return GetConsentsResponse(
+            self.get(f"/v2/api/identities/{identity_id}/consents"),
+        )