PyPI - ibm-cloud-sdk-core - Versions diffs - 3.20.6__tar.gz → 3.22.0__tar.gz - Mend

ibm-cloud-sdk-core 3.20.6tar.gz → 3.22.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (71) hide show

ibm_cloud_sdk_core-3.22.0/PKG-INFO ADDED Viewed

@@ -0,0 +1,160 @@
+Metadata-Version: 2.1
+Name: ibm-cloud-sdk-core
+Version: 3.22.0
+Summary: Core library used by SDKs for IBM Cloud Services
+Author-email: IBM <devxsdk@us.ibm.com>
+Project-URL: Repository, https://github.com/IBM/python-sdk-core
+Project-URL: Documentation, https://github.com/IBM/python-sdk-core/blob/main/README.md
+Project-URL: Issues, https://github.com/IBM/python-sdk-core/issues
+Project-URL: Changelog, https://github.com/IBM/python-sdk-core/blob/main/CHANGELOG.md
+Project-URL: Contributing, https://github.com/IBM/python-sdk-core/blob/main/CONTRIBUTING.md
+Project-URL: License, https://github.com/IBM/python-sdk-core/blob/main/LICENSE
+Keywords: ibm,cloud,ibm cloud services
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0.0,>=2.31.0
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python_dateutil<3.0.0,>=2.8.2
+Requires-Dist: PyJWT<3.0.0,>=2.8.0
+Provides-Extra: dev
+Requires-Dist: coverage<8.0.0,>=7.3.2; extra == "dev"
+Requires-Dist: pylint<4.0.0,>=3.0.0; extra == "dev"
+Requires-Dist: pytest<8.0.0,>=7.4.2; extra == "dev"
+Requires-Dist: pytest-cov<5.0.0,>=4.1.0; extra == "dev"
+Requires-Dist: responses<1.0.0,>=0.23.3; extra == "dev"
+Requires-Dist: black<25.0.0,>=24.0.0; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
+[![Build Status](https://app.travis-ci.com/IBM/python-sdk-core.svg?branch=main)](https://app.travis-ci.com/IBM/python-sdk-core)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ibm-cloud-sdk-core)](https://pypi.org/project/ibm-cloud-sdk-core/)
+[![Latest Stable Version](https://img.shields.io/pypi/v/ibm-cloud-sdk-core.svg)](https://pypi.python.org/pypi/ibm-cloud-sdk-core)
+[![CLA assistant](https://cla-assistant.io/readme/badge/ibm/python-sdk-core)](https://cla-assistant.io/ibm/python-sdk-core)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+# IBM Python SDK Core Version 3.22.0
+This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
+(openapi-sdkgen).
+# Python Version
+The current minimum Python version supported is 3.8.
+## Installation
+To install, use `pip`:
+```bash
+python -m pip install --upgrade ibm-cloud-sdk-core
+```
+## Authentication
+The python-sdk-core project supports the following types of authentication:
+- Basic Authentication
+- Bearer Token Authentication
+- Identity and Access Management (IAM) Authentication (grant type: apikey)
+- Identity and Access Management (IAM) Authentication (grant type: assume)
+- Container Authentication
+- VPC Instance Authentication
+- Cloud Pak for Data Authentication
+- No Authentication (for testing)
+For more information about the various authentication types and how to use them with your services, click [here](Authentication.md).
+## Issues
+If you encounter an issue with this project, you are welcome to submit a [bug report](https://github.com/IBM/python-sdk-core/issues).
+Before opening a new issue, please search for similar issues. It's possible that someone has already reported it.
+## Logging
+This library uses Python's built-in `logging` module to perform logging of error,
+warning, informational and debug messages.
+The components within the SDK Core library use a single logger named `ibm-cloud-sdk-core`.
+For complete information on the logging facility, please see: [Logging facility for Python](https://docs.python.org/3/library/logging.html).
+### Enable logging
+There are various ways to configure and enable the logging facility.
+The code example below demonstrates a simple way to enable debug logging by invoking
+the `logging.basicConfig()` function.
+Note that, as a convenience, if you set the logging level to `DEBUG`, then HTTP request/response message logging
+is also enabled.
+The following code example shows how debug logging can be enabled:
+```python
+import logging
+# Create a basic logging configuration that:
+# 1. Defines a handler to display messages on the console.
+# 2. Sets the root logger's logging level to DEBUG.
+# 3. Sets the 'format' string used to display messages.
+logging.basicConfig(level=logging.DEBUG, format='%(asctime)s [%(name)s:%(levelname)s] %(message)s', force=True)
+```
+When running your application, you should see output like this if debug logging is enabled:
+```
+2024-09-16 15:44:45,174 [ibm-cloud-sdk-core:DEBUG] Get authenticator from environment, key=global_search
+2024-09-16 15:44:45,175 [ibm-cloud-sdk-core:DEBUG] Set service URL: https://api.global-search-tagging.cloud.ibm.com
+2024-09-16 15:44:45,175 [ibm-cloud-sdk-core:DEBUG] Set User-Agent: ibm-python-sdk-core-3.22.0 os.name=Linux os.version=6.10.9-100.fc39.x86_64 python.version=3.12.5
+2024-09-16 15:44:45,181 [ibm-cloud-sdk-core:DEBUG] Configuring BaseService instance with service name: global_search
+2024-09-16 15:44:45,181 [ibm-cloud-sdk-core:DEBUG] Performing synchronous token fetch
+2024-09-16 15:44:45,182 [ibm-cloud-sdk-core:DEBUG] Invoking IAM get_token operation: https://iam.cloud.ibm.com/identity/token
+2024-09-16 15:44:45,182 [urllib3.connectionpool:DEBUG] Starting new HTTPS connection (1): iam.cloud.ibm.com:443
+send: b'POST /identity/token HTTP/1.1\r\nHost: iam.cloud.ibm.com\r\nUser-Agent: ibm-python-sdk-core/iam-authenticator-3.22.0 os.name=Linux os.version=6.10.9-100.fc39.x86_64 python.version=3.12.5\r\nAccept-Encoding: gzip, deflate\r\nAccept: application/json\r\nConnection: keep-alive\r\nContent-Type: application/x-www-form-urlencoded\r\nContent-Length: 135\r\n\r\n'
+send: b'grant_type=urn%3Aibm%3Aparams%3Aoauth%3Agrant-type%3Aapikey&apikey=[redacted]&response_type=cloud_iam'
+reply: 'HTTP/1.1 200 OK\r\n'
+header: Content-Type: application/json
+header: Content-Language: en-US
+header: Content-Encoding: gzip
+header: Date: Mon, 16 Sep 2024 20:44:45 GMT
+header: Content-Length: 983
+header: Connection: keep-alive
+2024-09-16 15:44:45,670 [urllib3.connectionpool:DEBUG] https://iam.cloud.ibm.com:443 "POST /identity/token HTTP/11" 200 983
+2024-09-16 15:44:45,672 [ibm-cloud-sdk-core:DEBUG] Returned from IAM get_token operation
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Authenticated outbound request (type=iam)
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Prepared request [POST https://api.global-search-tagging.cloud.ibm.com/v3/resources/search]
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Sending HTTP request message
+2024-09-16 15:44:45,674 [urllib3.connectionpool:DEBUG] Starting new HTTPS connection (1): api.global-search-tagging.cloud.ibm.com:443
+send: b'POST /v3/resources/search?limit=1 HTTP/1.1\r\nHost: api.global-search-tagging.cloud.ibm.com\r\nUser-Agent: platform-services-python-sdk/0.57.0 (lang=python; os.name=Linux; os.version=6.10.9-100.fc39.x86_64; python.version=3.12.5)\r\nAccept-Encoding: gzip, deflate\r\nAccept: application/json\r\nConnection: keep-alive\r\ncontent-type: application/json\r\nAuthorization: [redacted]\r\nContent-Length: 39\r\n\r\n'
+send: b'{"query": "GST-sdk-*", "fields": ["*"]}'
+reply: 'HTTP/1.1 200 OK\r\n'
+header: Content-Type: application/json
+header: Content-Length: 22
+header: Date: Mon, 16 Sep 2024 20:44:46 GMT
+header: Connection: keep-alive
+2024-09-16 15:44:46,079 [urllib3.connectionpool:DEBUG] https://api.global-search-tagging.cloud.ibm.com:443 "POST /v3/resources/search?limit=1 HTTP/11" 200 22
+2024-09-16 15:44:46,080 [ibm-cloud-sdk-core:DEBUG] Received HTTP response message, status code 200
+```
+## Open source @ IBM
+Find more open source projects on the [IBM Github Page](http://github.com/IBM)
+## License
+This library is licensed under Apache 2.0. Full license text is
+available in [LICENSE](LICENSE).
+## Contributing
+See [CONTRIBUTING.md](CONTRIBUTING.md).

ibm_cloud_sdk_core-3.22.0/README.md ADDED Viewed

@@ -0,0 +1,115 @@
+[![Build Status](https://app.travis-ci.com/IBM/python-sdk-core.svg?branch=main)](https://app.travis-ci.com/IBM/python-sdk-core)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ibm-cloud-sdk-core)](https://pypi.org/project/ibm-cloud-sdk-core/)
+[![Latest Stable Version](https://img.shields.io/pypi/v/ibm-cloud-sdk-core.svg)](https://pypi.python.org/pypi/ibm-cloud-sdk-core)
+[![CLA assistant](https://cla-assistant.io/readme/badge/ibm/python-sdk-core)](https://cla-assistant.io/ibm/python-sdk-core)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+# IBM Python SDK Core Version 3.22.0
+This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
+(openapi-sdkgen).
+# Python Version
+The current minimum Python version supported is 3.8.
+## Installation
+To install, use `pip`:
+```bash
+python -m pip install --upgrade ibm-cloud-sdk-core
+```
+## Authentication
+The python-sdk-core project supports the following types of authentication:
+- Basic Authentication
+- Bearer Token Authentication
+- Identity and Access Management (IAM) Authentication (grant type: apikey)
+- Identity and Access Management (IAM) Authentication (grant type: assume)
+- Container Authentication
+- VPC Instance Authentication
+- Cloud Pak for Data Authentication
+- No Authentication (for testing)
+For more information about the various authentication types and how to use them with your services, click [here](Authentication.md).
+## Issues
+If you encounter an issue with this project, you are welcome to submit a [bug report](https://github.com/IBM/python-sdk-core/issues).
+Before opening a new issue, please search for similar issues. It's possible that someone has already reported it.
+## Logging
+This library uses Python's built-in `logging` module to perform logging of error,
+warning, informational and debug messages.
+The components within the SDK Core library use a single logger named `ibm-cloud-sdk-core`.
+For complete information on the logging facility, please see: [Logging facility for Python](https://docs.python.org/3/library/logging.html).
+### Enable logging
+There are various ways to configure and enable the logging facility.
+The code example below demonstrates a simple way to enable debug logging by invoking
+the `logging.basicConfig()` function.
+Note that, as a convenience, if you set the logging level to `DEBUG`, then HTTP request/response message logging
+is also enabled.
+The following code example shows how debug logging can be enabled:
+```python
+import logging
+# Create a basic logging configuration that:
+# 1. Defines a handler to display messages on the console.
+# 2. Sets the root logger's logging level to DEBUG.
+# 3. Sets the 'format' string used to display messages.
+logging.basicConfig(level=logging.DEBUG, format='%(asctime)s [%(name)s:%(levelname)s] %(message)s', force=True)
+```
+When running your application, you should see output like this if debug logging is enabled:
+```
+2024-09-16 15:44:45,174 [ibm-cloud-sdk-core:DEBUG] Get authenticator from environment, key=global_search
+2024-09-16 15:44:45,175 [ibm-cloud-sdk-core:DEBUG] Set service URL: https://api.global-search-tagging.cloud.ibm.com
+2024-09-16 15:44:45,175 [ibm-cloud-sdk-core:DEBUG] Set User-Agent: ibm-python-sdk-core-3.22.0 os.name=Linux os.version=6.10.9-100.fc39.x86_64 python.version=3.12.5
+2024-09-16 15:44:45,181 [ibm-cloud-sdk-core:DEBUG] Configuring BaseService instance with service name: global_search
+2024-09-16 15:44:45,181 [ibm-cloud-sdk-core:DEBUG] Performing synchronous token fetch
+2024-09-16 15:44:45,182 [ibm-cloud-sdk-core:DEBUG] Invoking IAM get_token operation: https://iam.cloud.ibm.com/identity/token
+2024-09-16 15:44:45,182 [urllib3.connectionpool:DEBUG] Starting new HTTPS connection (1): iam.cloud.ibm.com:443
+send: b'POST /identity/token HTTP/1.1\r\nHost: iam.cloud.ibm.com\r\nUser-Agent: ibm-python-sdk-core/iam-authenticator-3.22.0 os.name=Linux os.version=6.10.9-100.fc39.x86_64 python.version=3.12.5\r\nAccept-Encoding: gzip, deflate\r\nAccept: application/json\r\nConnection: keep-alive\r\nContent-Type: application/x-www-form-urlencoded\r\nContent-Length: 135\r\n\r\n'
+send: b'grant_type=urn%3Aibm%3Aparams%3Aoauth%3Agrant-type%3Aapikey&apikey=[redacted]&response_type=cloud_iam'
+reply: 'HTTP/1.1 200 OK\r\n'
+header: Content-Type: application/json
+header: Content-Language: en-US
+header: Content-Encoding: gzip
+header: Date: Mon, 16 Sep 2024 20:44:45 GMT
+header: Content-Length: 983
+header: Connection: keep-alive
+2024-09-16 15:44:45,670 [urllib3.connectionpool:DEBUG] https://iam.cloud.ibm.com:443 "POST /identity/token HTTP/11" 200 983
+2024-09-16 15:44:45,672 [ibm-cloud-sdk-core:DEBUG] Returned from IAM get_token operation
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Authenticated outbound request (type=iam)
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Prepared request [POST https://api.global-search-tagging.cloud.ibm.com/v3/resources/search]
+2024-09-16 15:44:45,673 [ibm-cloud-sdk-core:DEBUG] Sending HTTP request message
+2024-09-16 15:44:45,674 [urllib3.connectionpool:DEBUG] Starting new HTTPS connection (1): api.global-search-tagging.cloud.ibm.com:443
+send: b'POST /v3/resources/search?limit=1 HTTP/1.1\r\nHost: api.global-search-tagging.cloud.ibm.com\r\nUser-Agent: platform-services-python-sdk/0.57.0 (lang=python; os.name=Linux; os.version=6.10.9-100.fc39.x86_64; python.version=3.12.5)\r\nAccept-Encoding: gzip, deflate\r\nAccept: application/json\r\nConnection: keep-alive\r\ncontent-type: application/json\r\nAuthorization: [redacted]\r\nContent-Length: 39\r\n\r\n'
+send: b'{"query": "GST-sdk-*", "fields": ["*"]}'
+reply: 'HTTP/1.1 200 OK\r\n'
+header: Content-Type: application/json
+header: Content-Length: 22
+header: Date: Mon, 16 Sep 2024 20:44:46 GMT
+header: Connection: keep-alive
+2024-09-16 15:44:46,079 [urllib3.connectionpool:DEBUG] https://api.global-search-tagging.cloud.ibm.com:443 "POST /v3/resources/search?limit=1 HTTP/11" 200 22
+2024-09-16 15:44:46,080 [ibm-cloud-sdk-core:DEBUG] Received HTTP response message, status code 200
+```
+## Open source @ IBM
+Find more open source projects on the [IBM Github Page](http://github.com/IBM)
+## License
+This library is licensed under Apache 2.0. Full license text is
+available in [LICENSE](LICENSE).
+## Contributing
+See [CONTRIBUTING.md](CONTRIBUTING.md).

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.22.0}/ibm_cloud_sdk_core/__init__.py RENAMED Viewed

@@ -18,6 +18,7 @@ classes:
     BaseService: Abstract class for common functionality between each service.
     DetailedResponse: The object returned from successful service operations.
     IAMTokenManager: Requests and refreshes IAM tokens using an apikey, and optionally a client_id and client_secret.
+    IAMAssumeTokenManager: Requests and refreshes IAM tokens using an apikey and a trusted profile.
     JWTTokenManager: Abstract class for common functionality between each JWT token manager.
     CP4DTokenManager: Requests and refreshes CP4D tokens given a username and password.
     ApiException: Custom exception class for errors returned from service operations.
@@ -39,6 +40,7 @@ functions:
 from .base_service import BaseService
 from .detailed_response import DetailedResponse
 from .token_managers.iam_token_manager import IAMTokenManager
+from .token_managers.iam_assume_token_manager import IAMAssumeTokenManager
 from .token_managers.jwt_token_manager import JWTTokenManager
 from .token_managers.cp4d_token_manager import CP4DTokenManager
 from .token_managers.container_token_manager import ContainerTokenManager

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.22.0}/ibm_cloud_sdk_core/authenticators/__init__.py RENAMED Viewed

@@ -39,6 +39,7 @@ from .bearer_token_authenticator import BearerTokenAuthenticator
 from .container_authenticator import ContainerAuthenticator
 from .cp4d_authenticator import CloudPakForDataAuthenticator
 from .iam_authenticator import IAMAuthenticator
+from .iam_assume_authenticator import IAMAssumeAuthenticator
 from .vpc_instance_authenticator import VPCInstanceAuthenticator
 from .no_auth_authenticator import NoAuthAuthenticator
 from .mcsp_authenticator import MCSPAuthenticator

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.22.0}/ibm_cloud_sdk_core/authenticators/authenticator.py RENAMED Viewed

@@ -24,6 +24,7 @@ class Authenticator(ABC):
     AUTHTYPE_BASIC = 'basic'
     AUTHTYPE_BEARERTOKEN = 'bearerToken'
     AUTHTYPE_IAM = 'iam'
+    AUTHTYPE_IAM_ASSUME = 'iamAssume'
     AUTHTYPE_CONTAINER = 'container'
     AUTHTYPE_CP4D = 'cp4d'
     AUTHTYPE_VPC = 'vpc'

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.22.0}/ibm_cloud_sdk_core/authenticators/basic_authenticator.py RENAMED Viewed

@@ -1,6 +1,6 @@
 # coding: utf-8
-# Copyright 2019 IBM All Rights Reserved.
+# Copyright 2019, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,11 +15,15 @@
 # limitations under the License.
 import base64
 from requests import Request
+from ibm_cloud_sdk_core.logger import get_logger
 from .authenticator import Authenticator
 from ..utils import has_bad_first_or_last_char
+logger = get_logger()
 class BasicAuthenticator(Authenticator):
     """The BasicAuthenticator is used to add basic authentication information to requests.
@@ -41,6 +45,7 @@ class BasicAuthenticator(Authenticator):
         self.password = password
         self.validate()
         self.authorization_header = self.__construct_basic_auth_header()
+        logger.debug('Created new BasicAuthenticator instance!')
     def authentication_type(self) -> str:
         """Returns this authenticator's type ('basic')."""
@@ -81,3 +86,4 @@ class BasicAuthenticator(Authenticator):
         """
         headers = req.get('headers')
         headers['Authorization'] = self.authorization_header
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.22.0}/ibm_cloud_sdk_core/authenticators/bearer_token_authenticator.py RENAMED Viewed

@@ -1,6 +1,6 @@
 # coding: utf-8
-# Copyright 2019 IBM All Rights Reserved.
+# Copyright 2019, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,8 +16,11 @@
 from requests import Request
+from ibm_cloud_sdk_core.logger import get_logger
 from .authenticator import Authenticator
+logger = get_logger()
 class BearerTokenAuthenticator(Authenticator):
     """The BearerTokenAuthenticator will add a user-supplied bearer token
@@ -37,6 +40,7 @@ class BearerTokenAuthenticator(Authenticator):
     def __init__(self, bearer_token: str) -> None:
         self.bearer_token = bearer_token
         self.validate()
+        logger.debug('Created BearerTokenAuthenticator instance!')
     def authentication_type(self) -> str:
         """Returns this authenticator's type ('bearertoken')."""
@@ -66,6 +70,7 @@ class BearerTokenAuthenticator(Authenticator):
         """
         headers = req.get('headers')
         headers['Authorization'] = 'Bearer {0}'.format(self.bearer_token)
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())
     def set_bearer_token(self, bearer_token: str) -> None:
         """Set a new bearer token to be sent in subsequent service operations.

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.22.0}/ibm_cloud_sdk_core/authenticators/container_authenticator.py RENAMED Viewed

@@ -66,6 +66,7 @@ class ContainerAuthenticator(IAMRequestBasedAuthenticator):
     def __init__(
         self,
+        *,
         cr_token_filename: Optional[str] = None,
         iam_profile_name: Optional[str] = None,
         iam_profile_id: Optional[str] = None,

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.22.0}/ibm_cloud_sdk_core/authenticators/cp4d_authenticator.py RENAMED Viewed

@@ -1,6 +1,6 @@
 # coding: utf-8
-# Copyright 2019 IBM All Rights Reserved.
+# Copyright 2019, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,13 +15,15 @@
 # limitations under the License.
 from typing import Dict, Optional
 from requests import Request
+from ibm_cloud_sdk_core.logger import get_logger
 from .authenticator import Authenticator
 from ..token_managers.cp4d_token_manager import CP4DTokenManager
 from ..utils import has_bad_first_or_last_char
+logger = get_logger()
 class CloudPakForDataAuthenticator(Authenticator):
     """The CloudPakForDataAuthenticator utilizes a username and password pair to
@@ -133,6 +135,7 @@ class CloudPakForDataAuthenticator(Authenticator):
         headers = req.get('headers')
         bearer_token = self.token_manager.get_token()
         headers['Authorization'] = 'Bearer {0}'.format(bearer_token)
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())
     def set_disable_ssl_verification(self, status: bool = False) -> None:
         """Set the flag that indicates whether verification of the server's SSL certificate should be

ibm_cloud_sdk_core-3.22.0/ibm_cloud_sdk_core/authenticators/iam_assume_authenticator.py ADDED Viewed

@@ -0,0 +1,146 @@
+# coding: utf-8
+# Copyright 2024 IBM All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from typing import Any, Dict, Optional
+from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator
+from ibm_cloud_sdk_core.token_managers.iam_assume_token_manager import IAMAssumeTokenManager
+from .authenticator import Authenticator
+from .iam_request_based_authenticator import IAMRequestBasedAuthenticator
+class IAMAssumeAuthenticator(IAMRequestBasedAuthenticator):
+    """IAMAssumeAuthenticator obtains an IAM access token using the IAM "get-token" operation's
+    "assume" grant type. The authenticator obtains an initial IAM access token from a
+    user-supplied apikey, then exchanges this initial IAM access token for another IAM access token
+    that has "assumed the identity" of the specified trusted profile.
+    The bearer token will be sent as an Authorization header in the form:
+        Authorization: Bearer <bearer-token>
+    Args:
+        apikey: The IAM api key.
+    Keyword Args:
+        iam_profile_id: the ID of the trusted profile
+        iam_profile_crn: the CRN of the trusted profile
+        iam_profile_name: the name of the trusted profile (must be used together with `iam_account_id`)
+        iam_account_id: the ID of the trusted profile (must be used together with `iam_profile_name`)
+        url: The URL representing the IAM token service endpoint. If not specified, a suitable default value is used.
+        client_id: The client_id and client_secret fields are used to form
+            a "basic" authorization header for IAM token requests. Defaults to None.
+        client_secret: The client_id and client_secret fields are used to form
+            a "basic" authorization header for IAM token requests. Defaults to None.
+        disable_ssl_verification: A flag that indicates whether verification of
+            the server's SSL certificate should be disabled or not. Defaults to False.
+        headers: Default headers to be sent with every IAM token request. Defaults to None.
+        proxies: Dictionary for mapping request protocol to proxy URL. Defaults to None.
+        proxies.http (optional): The proxy endpoint to use for HTTP requests.
+        proxies.https (optional): The proxy endpoint to use for HTTPS requests.
+        scope: The "scope" to use when fetching the bearer token from the IAM token server.
+            This can be used to obtain an access token with a specific scope.
+    Attributes:
+        token_manager (IAMTokenManager): Retrieves and manages IAM tokens from the endpoint specified by the url.
+    Raises:
+        TypeError: The `disable_ssl_verification` is not a bool.
+        ValueError: The `apikey`, `client_id`, and/or `client_secret` are not valid for IAM token requests or the
+            following keyword arguments are incorrectly specified:
+            `iam_profile_id`, `iam_profile_crn`, `iam_profile_name`, `iam_account_id`.
+    """
+    def __init__(
+        self,
+        apikey: str,
+        *,
+        iam_profile_id: Optional[str] = None,
+        iam_profile_crn: Optional[str] = None,
+        iam_profile_name: Optional[str] = None,
+        iam_account_id: Optional[str] = None,
+        url: Optional[str] = None,
+        client_id: Optional[str] = None,
+        client_secret: Optional[str] = None,
+        disable_ssl_verification: bool = False,
+        headers: Optional[Dict[str, str]] = None,
+        proxies: Optional[Dict[str, str]] = None,
+        scope: Optional[str] = None,
+    ) -> None:
+        # Check the type of `disable_ssl_verification`. Must be a bool.
+        if not isinstance(disable_ssl_verification, bool):
+            raise TypeError('disable_ssl_verification must be a bool')
+        self.token_manager = IAMAssumeTokenManager(
+            apikey,
+            iam_profile_id=iam_profile_id,
+            iam_profile_crn=iam_profile_crn,
+            iam_profile_name=iam_profile_name,
+            iam_account_id=iam_account_id,
+            url=url,
+            client_id=client_id,
+            client_secret=client_secret,
+            disable_ssl_verification=disable_ssl_verification,
+            headers=headers,
+            proxies=proxies,
+            scope=scope,
+        )
+        self.validate()
+    # Disable all setter methods, inherited from the parent class.
+    def __getattribute__(self, name: str) -> Any:
+        if name.startswith("set_"):
+            raise AttributeError(f"'{self.__class__.__name__}' has no attribute '{name}'")
+        return super().__getattribute__(name)
+    def authentication_type(self) -> str:
+        """Returns this authenticator's type ('iamAssume')."""
+        return Authenticator.AUTHTYPE_IAM_ASSUME
+    def validate(self) -> None:
+        """Validates the provided IAM related arguments.
+        Ensure the following:
+        - `apikey` of the IAMTokenManager is not `None`, and has no bad characters
+        - both `client_id` and `client_secret` are set if either of them are defined
+        - the correct number and type of IAM profile and IAM account options are specified
+        Raises:
+            ValueError: The apikey, client_id, and/or client_secret are not valid for IAM token requests.
+        """
+        # Create a temporary IAM authenticator that we can use to validate our delegate.
+        tmp_authenticator = IAMAuthenticator("")
+        tmp_authenticator.token_manager = self.token_manager.iam_delegate
+        tmp_authenticator.validate()
+        del tmp_authenticator
+        # Only one of the following arguments must be specified.
+        mutually_exclusive_attributes = [
+            self.token_manager.iam_profile_id,
+            self.token_manager.iam_profile_crn,
+            self.token_manager.iam_profile_name,
+        ]
+        if list(map(bool, mutually_exclusive_attributes)).count(True) != 1:
+            raise ValueError(
+                'Exactly one of `iam_profile_id`, `iam_profile_crn`, or `iam_profile_name` must be specified.'
+            )
+        # `iam_account_id` must be specified iff `iam_profile_name` is used.
+        if self.token_manager.iam_profile_name and not self.token_manager.iam_account_id:
+            raise ValueError('`iam_profile_name` and `iam_account_id` must be provided together, or not at all.')

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.22.0}/ibm_cloud_sdk_core/authenticators/iam_request_based_authenticator.py RENAMED Viewed

@@ -1,6 +1,6 @@
 # coding: utf-8
-# Copyright 2019 IBM All Rights Reserved.
+# Copyright 2019, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,8 +18,11 @@ from typing import Dict
 from requests import Request
+from ibm_cloud_sdk_core.logger import get_logger
 from .authenticator import Authenticator
+logger = get_logger()
 class IAMRequestBasedAuthenticator(Authenticator):
     """The IAMRequestBasedAuthenticator class contains code that is common to all authenticators
@@ -60,6 +63,7 @@ class IAMRequestBasedAuthenticator(Authenticator):
         headers = req.get('headers')
         bearer_token = self.token_manager.get_token()
         headers['Authorization'] = 'Bearer {0}'.format(bearer_token)
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())
     def set_client_id_and_secret(self, client_id: str, client_secret: str) -> None:
         """Set the client_id and client_secret pair the token manager will use for IAM token requests.

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.22.0}/ibm_cloud_sdk_core/authenticators/mcsp_authenticator.py RENAMED Viewed

@@ -1,6 +1,6 @@
 # coding: utf-8
-# Copyright 2023 IBM All Rights Reserved.
+# Copyright 2023, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,9 +18,12 @@ from typing import Dict, Optional
 from requests import Request
+from ibm_cloud_sdk_core.logger import get_logger
 from .authenticator import Authenticator
 from ..token_managers.mcsp_token_manager import MCSPTokenManager
+logger = get_logger()
 class MCSPAuthenticator(Authenticator):
     """The MCSPAuthenticator uses an apikey to obtain an access token from the MCSP token server.
@@ -98,6 +101,7 @@ class MCSPAuthenticator(Authenticator):
         headers = req.get('headers')
         bearer_token = self.token_manager.get_token()
         headers['Authorization'] = 'Bearer {0}'.format(bearer_token)
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())
     def set_disable_ssl_verification(self, status: bool = False) -> None:
         """Set the flag that indicates whether verification of the server's SSL certificate should be

{ibm_cloud_sdk_core-3.20.6 → ibm_cloud_sdk_core-3.22.0}/ibm_cloud_sdk_core/authenticators/vpc_instance_authenticator.py RENAMED Viewed

@@ -1,6 +1,6 @@
 # coding: utf-8
-# Copyright 2021 IBM All Rights Reserved.
+# Copyright 2021, 2024 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,9 +18,12 @@ from typing import Optional
 from requests import Request
+from ibm_cloud_sdk_core.logger import get_logger
 from ..token_managers.vpc_instance_token_manager import VPCInstanceTokenManager
 from .authenticator import Authenticator
+logger = get_logger()
 class VPCInstanceAuthenticator(Authenticator):
     """VPCInstanceAuthenticator implements an authentication scheme in which it
@@ -89,6 +92,7 @@ class VPCInstanceAuthenticator(Authenticator):
         headers = req.get('headers')
         bearer_token = self.token_manager.get_token()
         headers['Authorization'] = 'Bearer {0}'.format(bearer_token)
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())
     def set_iam_profile_crn(self, iam_profile_crn: str) -> None:
         """Sets CRN of the IAM profile.

ibm-cloud-sdk-core 3.20.6__tar.gz → 3.22.0__tar.gz

ibm-cloud-sdk-core 3.20.6tar.gz → 3.22.0tar.gz