ibm-cloud-sdk-core 3.20.5__tar.gz → 3.21.0__tar.gz

ibm_cloud_sdk_core-3.21.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.1
+Name: ibm-cloud-sdk-core
+Version: 3.21.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.21.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
+- 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.21.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.21.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.21.0/README.md

@@ -0,0 +1,114 @@
+[![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.21.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
+- 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.21.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.21.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.21.0/ibm_cloud_sdk_core/authenticators/__init__.py

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+# Copyright 2019 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.
+"""The ibm_cloud_sdk_core project supports the following types of authentication:
+
+  Basic Authentication
+  Bearer Token
+  Identity and Access Management (IAM)
+  Cloud Pak for Data
+  No Authentication
+
+  The authentication types that are appropriate for a particular service may vary from service to service.
+  Each authentication type is implemented as an Authenticator for consumption by a service.
+
+classes:
+  Authenticator: Abstract Base Class. Implement this interface to provide custom authentication schemes to services.
+  BasicAuthenticator: Authenticator for passing supplied basic authentication information to service endpoint.
+  BearerTokenAuthenticator: Authenticator for passing supplied bearer token to service endpoint.
+  CloudPakForDataAuthenticator: Authenticator for passing CP4D authentication information to service endpoint.
+  IAMAuthenticator: Authenticator for passing IAM authentication information to service endpoint.
+  NoAuthAuthenticator: Performs no authentication. Useful for testing purposes.
+"""
+
+from .authenticator import Authenticator
+from .basic_authenticator import BasicAuthenticator
+from .bearer_token_authenticator import BearerTokenAuthenticator
+from .container_authenticator import ContainerAuthenticator
+from .cp4d_authenticator import CloudPakForDataAuthenticator
+from .iam_authenticator import IAMAuthenticator
+from .vpc_instance_authenticator import VPCInstanceAuthenticator
+from .no_auth_authenticator import NoAuthAuthenticator
+from .mcsp_authenticator import MCSPAuthenticator

ibm_cloud_sdk_core-3.21.0/ibm_cloud_sdk_core/authenticators/authenticator.py

@@ -0,0 +1,58 @@
+# coding: utf-8
+
+# Copyright 2019, 2023 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 abc import ABC, abstractmethod
+
+
+class Authenticator(ABC):
+    """This interface defines the common methods and constants associated with an Authenticator implementation."""
+
+    # Constants representing the various authenticator types.
+    AUTHTYPE_BASIC = 'basic'
+    AUTHTYPE_BEARERTOKEN = 'bearerToken'
+    AUTHTYPE_IAM = 'iam'
+    AUTHTYPE_CONTAINER = 'container'
+    AUTHTYPE_CP4D = 'cp4d'
+    AUTHTYPE_VPC = 'vpc'
+    AUTHTYPE_NOAUTH = 'noAuth'
+    AUTHTYPE_MCSP = 'mcsp'
+    AUTHTYPE_UNKNOWN = 'unknown'
+
+    @abstractmethod
+    def authenticate(self, req: dict) -> None:
+        """Perform the necessary authentication steps for the specified request.
+
+        Attributes:
+            req (dict): Will be modified to contain the appropriate authentication information.
+
+        To be implemented by subclasses.
+        """
+        pass
+
+    @abstractmethod
+    def validate(self) -> None:
+        """Validates the current set of configuration information in the Authenticator.
+
+        Raises:
+            ValueError: The configuration information is not valid for service operations.
+
+        To be implemented by subclasses.
+        """
+        pass
+
+    def authentication_type(self) -> str:
+        """Returns the authenticator's type.  This method should be overridden by each authenticator implementation."""
+        return self.AUTHTYPE_UNKNOWN

ibm_cloud_sdk_core-3.21.0/ibm_cloud_sdk_core/authenticators/basic_authenticator.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+# 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.
+# 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.
+
+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.
+
+    Basic Authorization will be sent as an Authorization header in the form:
+
+        Authorization: Basic <encoded username and password>
+
+    Args:
+        username: User-supplied username for basic auth.
+        password: User-supplied password for basic auth.
+
+    Raises:
+        ValueError: The username or password is not specified or contains invalid characters.
+    """
+
+    def __init__(self, username: str, password: str) -> None:
+        self.username = username
+        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')."""
+        return Authenticator.AUTHTYPE_BASIC
+
+    def validate(self) -> None:
+        """Validate username and password.
+
+        Ensure the username and password are valid for service operations.
+
+        Raises:
+            ValueError: The username and/or password is not valid for service operations.
+        """
+        if self.username is None or self.password is None:
+            raise ValueError('The username and password shouldn\'t be None.')
+
+        if has_bad_first_or_last_char(self.username) or has_bad_first_or_last_char(self.password):
+            raise ValueError(
+                'The username and password shouldn\'t start or end with curly brackets or quotes. '
+                'Please remove any surrounding {, }, or \" characters.'
+            )
+
+    def __construct_basic_auth_header(self) -> str:
+        authstring = "{0}:{1}".format(self.username, self.password)
+        base64_authorization = base64.b64encode(authstring.encode('utf-8')).decode('utf-8')
+        return 'Basic {0}'.format(base64_authorization)
+
+    def authenticate(self, req: Request) -> None:
+        """Add basic authentication information to a request.
+
+        Basic Authorization will be added to the request's headers in the form:
+
+            Authorization: Basic <encoded username and password>
+
+        Args:
+            req: The request to add basic auth information to. Must contain a key to a dictionary
+            called headers.
+        """
+        headers = req.get('headers')
+        headers['Authorization'] = self.authorization_header
+        logger.debug('Authenticated outbound request (type=%s)', self.authentication_type())

ibm_cloud_sdk_core-3.21.0/ibm_cloud_sdk_core/authenticators/bearer_token_authenticator.py

@@ -0,0 +1,85 @@
+# coding: utf-8
+
+# 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.
+# 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 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
+    to requests.
+
+    The bearer token will be sent as an Authorization header in the form:
+
+         Authorization: Bearer <bearer-token>
+
+    Args:
+        bearer_token: The user supplied bearer token.
+
+    Raises:
+        ValueError: Bearer token is none.
+    """
+
+    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')."""
+        return Authenticator.AUTHTYPE_BEARERTOKEN
+
+    def validate(self) -> None:
+        """Validate the bearer token.
+
+        Ensures the bearer token is valid for service operations.
+
+        Raises:
+            ValueError: The bearer token is not valid for service operations.
+        """
+        if self.bearer_token is None:
+            raise ValueError('The bearer token shouldn\'t be None.')
+
+    def authenticate(self, req: Request) -> None:
+        """Adds bearer authentication information to the request.
+
+        The bearer token will be added to the request's headers in the form:
+
+            Authorization: Bearer <bearer-token>
+
+        Args:
+            req: The request to add bearer authentication information to. Must contain a key to a dictionary
+            called headers.
+        """
+        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.
+
+        Args:
+            bearer_token: The bearer token that will be sent in service requests.
+
+        Raises:
+            ValueError: The bearer token is not valid for service operations.
+        """
+        self.bearer_token = bearer_token
+        self.validate()