pypomes-iam 0.3.6__py3-none-any.whl → 0.3.7__py3-none-any.whl

pypomes_iam/iam_services.py

@@ -21,9 +21,9 @@ def service_login() -> Response:
     """
     Entry point for the IAM server's login service.
 
-    Return the URL for the IAM server's authentication page, with the appropriate parameters.
+    Return the URL for invoking the IAM server's authentication page, with the appropriate parameters.
 
-    :return: the response from the operation
+    :return: *Response* with the URL for invoking the IAM server's authentication page, or *BAD REQUEST* if error
     """
     # declare the return variable
     result: Response | None = None
@@ -70,7 +70,7 @@ def service_logout() -> Response:
 
     Remove all data associating the user from the *IAM* server's registry.
 
-    :return: response *OK*, or response *BAD REQUEST* if error
+    :return: *Response NO CONTENT*, or *BAD REQUEST* if error
     """
     # declare the return variable
     result: Response | None
@@ -97,7 +97,7 @@ def service_logout() -> Response:
         result = Response("; ".join(errors))
         result.status_code = 400
     else:
-        result = Response(status=200)
+        result = Response(status=204)
 
     # log the response
     if logger:
@@ -118,7 +118,13 @@ def service_callback() -> Response:
     *IAM* server's login page, forwarding the data received. In a typical OAuth2 flow faction,
     this data is then used to effectively obtain the token from the *IAM* server.
 
-    :return: the *Response* containing the reference user identification and the token, or *BAD REQUEST*
+    On success, the returned *Response* will contain the following JSON:
+        {
+            "user-id": <reference-user-identification>,
+            "token": <token>
+        }
+
+    :return: *Response* containing the reference user identification and the token, or *BAD REQUEST*
     """
     # retrieve the operations's logger
     logger: Logger = _get_logger()
@@ -147,7 +153,7 @@ def service_callback() -> Response:
             logger.error(msg=json.dumps(obj=result))
     else:
         result = jsonify({"user-id": token_data[0],
-                          "access-token": token_data[1]})
+                          "token": token_data[1]})
     # log the response
     if logger:
         logger.debug(msg=f"Response {result}")
@@ -163,7 +169,13 @@ def service_token() -> Response:
     """
     Entry point for retrieving a token from the *IAM* server.
 
-    :return: the *Response* containing the user reference identification and the token, or *BAD REQUEST*
+    On success, the returned *Response* will contain the following JSON:
+        {
+            "user-id": <reference-user-identification>,
+            "token": <token>
+        }
+
+    :return: *Response* containing the user reference identification and the token, or *BAD REQUEST*
     """
     # retrieve the operations's logger
     logger: Logger = _get_logger()
@@ -224,7 +236,7 @@ def service_exchange() -> Response:
     If the exchange is successful, the token data is stored in the *IAM* server's registry, and returned.
     Otherwise, *errors* will contain the appropriate error message.
 
-    The typical *Response* returned contains the following attributes:
+    On success, the typical *Response* returned will contain the following attributes:
         {
             "token_type": "Bearer",
             "access_token": <str>,
@@ -233,7 +245,7 @@ def service_exchange() -> Response:
             "refesh_expires_in": <number-of-seconds>
         }
 
-    :return: the *Response* containing the token data, or *UNAUTHORIZED*
+    :return: *Response* containing the token data, or *BAD REQUEST*
     """
     # retrieve the operations's logger
     logger: Logger = _get_logger()

{pypomes_iam-0.3.6.dist-info → pypomes_iam-0.3.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypomes_iam
-Version: 0.3.6
+Version: 0.3.7
 Summary: A collection of Python pomes, penyeach (IAM modules)
 Project-URL: Homepage, https://github.com/TheWiseCoder/PyPomes-IAM
 Project-URL: Bug Tracker, https://github.com/TheWiseCoder/PyPomes-IAM/issues

{pypomes_iam-0.3.6.dist-info → pypomes_iam-0.3.7.dist-info}/RECORD

@@ -1,12 +1,12 @@
 pypomes_iam/__init__.py,sha256=H7rUCaUEJBLNJv2rtdmBxwcAB28OItdEPenpv_UEOVw,965
 pypomes_iam/iam_common.py,sha256=f74FUDcnMM2cgzJg-AF17GwCKwbfoezS8LppwxYwPys,10049
 pypomes_iam/iam_pomes.py,sha256=gvDpgff6arB4_Y8AAf6QH2CEWRmdy-kcnQLyD0hx4Y4,23966
-pypomes_iam/iam_services.py,sha256=Ae_hLz5luRjK-l_rhBcuuY03Ov7n7o67UYgBb5rbBys,10002
+pypomes_iam/iam_services.py,sha256=xs0y0FUBTDiVu_B_kP900Kp1D77wyphUBxb_-QlD07Y,10445
 pypomes_iam/jusbr_pomes.py,sha256=0qbjJ6EGnlx17K-4Lqh5XkfH58y0joVZiD6HykbwpoE,5823
 pypomes_iam/keycloak_pomes.py,sha256=5ZfpncofF20C1IB5ndO31vfrvfa8Ffy7FJxkGoKKoQQ,6836
 pypomes_iam/provider_pomes.py,sha256=3Rui68hmj8zwY0tnw4aWurz-yQ-niacJFQpi6nWzh-M,6355
 pypomes_iam/token_pomes.py,sha256=1g6PMNNMbmdwLrsvSXvpO8-zdRhso1IFnwAyndNmV4Q,5332
-pypomes_iam-0.3.6.dist-info/METADATA,sha256=q53TFkBnU4mUAZgsJ_r_730kASXLiIyCwW_5mkFz8TU,694
-pypomes_iam-0.3.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pypomes_iam-0.3.6.dist-info/licenses/LICENSE,sha256=YvUELgV8qvXlaYsy9hXG5EW3Bmsrkw-OJmmILZnonAc,1086
-pypomes_iam-0.3.6.dist-info/RECORD,,
+pypomes_iam-0.3.7.dist-info/METADATA,sha256=A97OOR7LyuCK84uBRzkQgwbfyqW6aBDxwaImnHM6iAk,694
+pypomes_iam-0.3.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pypomes_iam-0.3.7.dist-info/licenses/LICENSE,sha256=YvUELgV8qvXlaYsy9hXG5EW3Bmsrkw-OJmmILZnonAc,1086
+pypomes_iam-0.3.7.dist-info/RECORD,,