ibm-secrets-manager-instance-management-sdk 2.0.1__py3-none-any.whl

ibm_secrets_manager_instance_management_sdk-2.0.1.dist-info/METADATA

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: ibm-secrets-manager-instance-management-sdk
+Version: 2.0.1
+Summary: IBM Cloud Secrets Manager instance management Python SDK
+Project-URL: Repository, https://github.com/IBM/secrets-manager-management-python-sdk
+Project-URL: Documentation, https://cloud.ibm.com/apidocs/secrets-manager
+Project-URL: Issues, https://github.com/IBM/secrets-manager-management-python-sdk/issues
+Author-email: IBM <secrets.automation@ibm.com>
+License-File: LICENSE
+Keywords: cloud,control plane,ibm,ibm cloud services,instance management,secrets manager
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: ibm-cloud-sdk-core<4.0.0,>=3.24.4
+Requires-Dist: python-dateutil<3.0.0,>=2.5.3
+Requires-Dist: requests<3.0.0,>=2.32.4
+Requires-Dist: urllib3<3.0.0,>=2.6.3
+Provides-Extra: dev
+Requires-Dist: black<26.3.2,>=26.3.1; extra == 'dev'
+Requires-Dist: coverage<8.0.0,>=7.3.2; extra == 'dev'
+Requires-Dist: pylint<4.1.0,>=4.0.5; extra == 'dev'
+Requires-Dist: pytest-cov<7.2.0,>=7.1.0; extra == 'dev'
+Requires-Dist: pytest-rerunfailures>=3.1; extra == 'dev'
+Requires-Dist: pytest<9.1.0,>=9.0.2; extra == 'dev'
+Requires-Dist: python-dotenv>=0.19.0; extra == 'dev'
+Requires-Dist: responses<1.0.0,>=0.23.3; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# IBM Cloud Secrets Manager Management Python SDK
+A Python client library to interact with the IBM Cloud® Secrets Manager Instance Management APIs.
+
+> **Important:** This SDK is for use with instances of the IBM Cloud Secrets Manager **Vault Enterprise plan only**. It is not compatible with other Secrets Manager plans.
+
+<details>
+<summary>Table of Contents</summary>
+
+* [Overview](#overview)
+* [Prerequisites](#prerequisites)
+* [Installation](#installation)
+* [Authentication](#authentication)
+* [Using the SDK](#using-the-sdk)
+* [Issues](#issues)
+* [Contributing](#contributing)
+* [License](#license)
+
+</details>
+
+## Overview
+The IBM Cloud Secrets Manager Management Python SDK allows developers to programmatically interact with the following IBM Cloud services:
+
+| Service name                              | Imported class name                     |
+|-------------------------------------------|-----------------------------------------|
+| Secrets Manager Management | SecretsManagerInstanceManagementV2 |
+
+## Prerequisites
+- An [IBM Cloud account](https://cloud.ibm.com/registration).
+- A [Secrets Manager service instance](https://cloud.ibm.com/catalog/services/secrets-manager) with the **Vault Enterprise plan**.
+- An [IBM Cloud API key](https://cloud.ibm.com/iam/apikeys) that allows the SDK to access your account.
+- Python 3.9 or above.
+
+## Installation
+To install, use `pip` or `easy_install`:
+
+```bash
+pip install --upgrade "ibm-secrets-manager-instance-management-sdk"
+```
+
+or
+
+```bash
+easy_install --upgrade "ibm-secrets-manager-instance-management-sdk"
+```
+
+## Authentication
+Secrets Manager uses token-based Identity and Access Management (IAM) authentication.
+
+With IAM authentication, you supply an API key that is used to generate an access token. Then, the access token is included in each API request to Secrets Manager. Access tokens are valid for a limited amount of time and must be regenerated.
+Authentication for this SDK is accomplished by using [IAM authenticators](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md#authentication). Import authenticators from `ibm_cloud_sdk_core.authenticators`.
+
+### Examples
+#### Programmatic credentials
+
+```python
+from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator
+
+secretsManagerInstanceManagement = SecretsManagerInstanceManagementV2(
+    authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>')
+)
+```
+
+To learn more about IAM authenticators and how to use them in your Python application, see the [IBM Python SDK Core documentation](https://github.com/IBM/python-sdk-core/blob/master/Authentication.md).
+
+## Using the SDK
+
+### Basic usage
+
+- Use the `set_service_url` method to set the endpoint URL that is specific to your Secrets Manager service instance. To find your endpoint URL, you can copy it from the **Endpoints** section on the **Overview** page in the Secrets Manager UI.
+
+#### Examples
+
+Construct a service client and use it to generate an admin token and get instance details.
+
+Here's an example `secrets_manager_instance_management.py` file:
+
+```python
+from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator
+from ibm_secrets_manager_instance_management_sdk.secrets_manager_instance_management_v2 import *
+
+secretsManagerInstanceManagement = SecretsManagerInstanceManagementV2(
+    authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>')
+)
+
+secretsManagerInstanceManagement.set_service_url('<SERVICE_URL>')
+
+# Generate admin token
+response = secretsManagerInstanceManagement.admin_token_generate(
+    instance_crn='<INSTANCE_CRN>'
+)
+
+print('Admin token generated!')
+
+# Get instance details
+response = secretsManagerInstanceManagement.instance_details(
+    instance_crn='<INSTANCE_CRN>'
+)
+
+print('Instance details:')
+print(response.result)
+```
+
+Replace the `apikey`, `SERVICE_URL`, and `INSTANCE_CRN` values. Then use the `python secrets_manager_instance_management.py` command to run your
+application.
+
+For more information and IBM Cloud SDK usage examples for Python, see
+the [IBM Cloud SDK Common documentation](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
+
+## Issues
+
+If you encounter an issue with the project, you're welcome to submit
+a [bug report](https://github.com/IBM/secrets-manager-management-python-sdk/issues) to help us improve.
+
+## Contributing
+
+For general contribution guidelines, see [CONTRIBUTING](CONTRIBUTING.md).
+
+## License
+
+This SDK project is released under the Apache 2.0 license. The license's full text can be found in [LICENSE](LICENSE).

ibm_secrets_manager_instance_management_sdk-2.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+ibm_secrets_manager_sdk_instance_management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ibm_secrets_manager_sdk_instance_management/common.py,sha256=3w6hB31KtvtN09FpeZgkRWCuLNb5z6U4uXMDu_zzvMA,460
+ibm_secrets_manager_sdk_instance_management/secrets_manager_instance_management_v2.py,sha256=4r71xs48WsYNMd3CBVwbgkXkx2fBqqTpep9-3veLs08,27698
+ibm_secrets_manager_sdk_instance_management/version.py,sha256=HVx0XJJ9OYFWBBPBCUFYb8Nm43ChPg9GZLh_dkxh9qI,22
+ibm_secrets_manager_instance_management_sdk-2.0.1.dist-info/METADATA,sha256=tgyBDHtojdlzLNBVKWqSoe2JEjQVYLcaflTJv69a8rY,6502
+ibm_secrets_manager_instance_management_sdk-2.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ibm_secrets_manager_instance_management_sdk-2.0.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+ibm_secrets_manager_instance_management_sdk-2.0.1.dist-info/RECORD,,

ibm_secrets_manager_instance_management_sdk-2.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ibm_secrets_manager_instance_management_sdk-2.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

ibm_secrets_manager_sdk_instance_management/common.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# (C) Copyright IBM Corp. 2024.
+
+"""Common functionality for IBM Cloud SDK."""
+
+def get_sdk_headers(service_name=None, service_version=None, operation_id=None):
+    """Get SDK specific headers to be included in every API call."""
+    return {
+        'User-Agent': 'ibm-secrets-manager-vaas-sdk-python/0.0.1',
+        'X-SDK-Analytics': f'service_name={service_name};service_version={service_version};operation_id={operation_id}'
+    }

ibm_secrets_manager_sdk_instance_management/secrets_manager_instance_management_v2.py

@@ -0,0 +1,755 @@
+# coding: utf-8
+
+# (C) Copyright IBM Corp. 2026.
+#
+# 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.
+
+# IBM OpenAPI SDK Code Generator Version: 3.114.4-9b56d441-20260612-210048
+
+"""
+With IBM Cloud® Secrets Manager Instance Management API, you can manage service instances
+of the Vault Dedicated plan. Use the API for the following operations:
+- Get service instance details including cluster state, endpoints, and key management
+service.
+- Generate a Vault admin token for authenticating to your Vault Dedicated cluster.
+- Revoke all active Vault admin tokens.
+
+API Version: 2.0.0
+See: https://cloud.ibm.com/docs/secrets-manager
+"""
+
+from enum import Enum
+from typing import Dict, Optional
+import json
+
+from ibm_cloud_sdk_core import BaseService, DetailedResponse
+from ibm_cloud_sdk_core.authenticators.authenticator import Authenticator
+from ibm_cloud_sdk_core.get_authenticator import get_authenticator_from_environment
+
+from .common import get_sdk_headers
+
+##############################################################################
+# Service
+##############################################################################
+
+
+class SecretsManagerInstanceManagementV2(BaseService):
+    """The secrets-manager-instance-management V2 service."""
+
+    DEFAULT_SERVICE_URL = 'https://us-south.secrets-manager.cloud.ibm.com'
+    DEFAULT_SERVICE_NAME = 'secrets_manager_instance_management'
+
+    PARAMETERIZED_SERVICE_URL = 'https://{region}.secrets-manager.cloud.ibm.com'
+
+    @classmethod
+    def new_instance(
+        cls,
+        service_name: str = DEFAULT_SERVICE_NAME,
+    ) -> 'SecretsManagerInstanceManagementV2':
+        """
+        Return a new client for the secrets-manager-instance-management service
+               using the specified parameters and external configuration.
+        """
+        authenticator = get_authenticator_from_environment(service_name)
+        service = cls(
+            authenticator
+            )
+        service.configure_service(service_name)
+        return service
+
+    @classmethod
+    def construct_service_url(
+        cls,
+        region: str = 'us-south',
+    ) -> str:
+        """
+        Construct a service URL by formatting the parameterized service URL.
+
+        The parameterized service URL is:
+        'https://{region}.secrets-manager.cloud.ibm.com'
+
+        :param str region: (optional) The region where you provisioned your Vault Dedicated Instance. Available regions: us-south, eu-de, jp-tok
+            (default 'us-south')
+        :return: The formatted URL with all variable placeholders replaced by values.
+        :rtype: str
+        """
+        return cls.PARAMETERIZED_SERVICE_URL.format(
+            region=region,
+        )
+
+    def __init__(
+        self,
+        authenticator: Authenticator = None,
+    ) -> None:
+        """
+        Construct a new client for the secrets-manager-instance-management service.
+
+        :param Authenticator authenticator: The authenticator specifies the authentication mechanism.
+               Get up to date information from https://github.com/IBM/python-sdk-core/blob/main/README.md
+               about initializing the authenticator of your choice.
+        """
+        BaseService.__init__(self, service_url=self.DEFAULT_SERVICE_URL, authenticator=authenticator)
+
+    #########################
+    # Tokens
+    #########################
+
+    def create_vault_admintoken(
+        self,
+        instance_id: str,
+        **kwargs,
+    ) -> DetailedResponse:
+        """
+        Generate admin token.
+
+        Generate a Vault admin token for authenticating to your Vault Dedicated cluster.
+        The token is valid for 1 hour and grants administrative privileges. Use only for
+        initial setup and cluster management, then revoke immediately.
+
+        :param str instance_id: The service instance ID.
+        :param dict headers: A `dict` containing the request headers
+        :return: A `DetailedResponse` containing the result, headers and HTTP status code.
+        :rtype: DetailedResponse with `dict` result representing a `Token` object
+        """
+
+        if not instance_id:
+            raise ValueError('instance_id must be provided')
+        headers = {}
+        sdk_headers = get_sdk_headers(
+            service_name=self.DEFAULT_SERVICE_NAME,
+            service_version='V2',
+            operation_id='create_vault_admintoken',
+        )
+        headers.update(sdk_headers)
+
+        if 'headers' in kwargs:
+            headers.update(kwargs.get('headers'))
+            del kwargs['headers']
+        headers['Accept'] = 'application/json'
+
+        path_param_keys = ['instance_id']
+        path_param_values = self.encode_path_vars(instance_id)
+        path_param_dict = dict(zip(path_param_keys, path_param_values))
+        url = '/api/v2/instances/{instance_id}/admintokens'.format(**path_param_dict)
+        request = self.prepare_request(
+            method='POST',
+            url=url,
+            headers=headers,
+        )
+
+        response = self.send(request, **kwargs)
+        return response
+
+    def delete_instance_admintokens(
+        self,
+        instance_id: str,
+        **kwargs,
+    ) -> DetailedResponse:
+        """
+        Revoke admin tokens.
+
+        Revoke all active Vault admin tokens. This immediately invalidates all existing
+        admin tokens.
+
+        :param str instance_id: The service instance ID.
+        :param dict headers: A `dict` containing the request headers
+        :return: A `DetailedResponse` containing the result, headers and HTTP status code.
+        :rtype: DetailedResponse
+        """
+
+        if not instance_id:
+            raise ValueError('instance_id must be provided')
+        headers = {}
+        sdk_headers = get_sdk_headers(
+            service_name=self.DEFAULT_SERVICE_NAME,
+            service_version='V2',
+            operation_id='delete_instance_admintokens',
+        )
+        headers.update(sdk_headers)
+
+        if 'headers' in kwargs:
+            headers.update(kwargs.get('headers'))
+            del kwargs['headers']
+
+        path_param_keys = ['instance_id']
+        path_param_values = self.encode_path_vars(instance_id)
+        path_param_dict = dict(zip(path_param_keys, path_param_values))
+        url = '/api/v2/instances/{instance_id}/admintokens'.format(**path_param_dict)
+        request = self.prepare_request(
+            method='DELETE',
+            url=url,
+            headers=headers,
+        )
+
+        response = self.send(request, **kwargs)
+        return response
+
+    #########################
+    # Instances
+    #########################
+
+    def get_instance(
+        self,
+        instance_id: str,
+        **kwargs,
+    ) -> DetailedResponse:
+        """
+        Get instance details.
+
+        Get service instance details including cluster state, endpoints, and key
+        management service.
+
+        :param str instance_id: The service instance ID.
+        :param dict headers: A `dict` containing the request headers
+        :return: A `DetailedResponse` containing the result, headers and HTTP status code.
+        :rtype: DetailedResponse with `dict` result representing a `Instance` object
+        """
+
+        if not instance_id:
+            raise ValueError('instance_id must be provided')
+        headers = {}
+        sdk_headers = get_sdk_headers(
+            service_name=self.DEFAULT_SERVICE_NAME,
+            service_version='V2',
+            operation_id='get_instance',
+        )
+        headers.update(sdk_headers)
+
+        if 'headers' in kwargs:
+            headers.update(kwargs.get('headers'))
+            del kwargs['headers']
+        headers['Accept'] = 'application/json'
+
+        path_param_keys = ['instance_id']
+        path_param_values = self.encode_path_vars(instance_id)
+        path_param_dict = dict(zip(path_param_keys, path_param_values))
+        url = '/api/v2/instances/{instance_id}'.format(**path_param_dict)
+        request = self.prepare_request(
+            method='GET',
+            url=url,
+            headers=headers,
+        )
+
+        response = self.send(request, **kwargs)
+        return response
+
+
+##############################################################################
+# Models
+##############################################################################
+
+
+class Instance:
+    """
+    The service instance information.
+
+    :param str instance_crn: The instance CRN identifier.
+    :param str plan: Instance plan name.
+    :param VaultDedicatedCluster vault_cluster: Vault cluster information for Vault
+          Dedicated instances.
+    :param VaultDedicatedInstanceEndpoints endpoints: Instance endpoints for Vault
+          Dedicated instances.
+    :param VaultDedicatedInstanceEncryption encryption: Vault encryption
+          configuration for Vault Dedicated instances.
+    """
+
+    def __init__(
+        self,
+        instance_crn: str,
+        plan: str,
+        vault_cluster: 'VaultDedicatedCluster',
+        endpoints: 'VaultDedicatedInstanceEndpoints',
+        encryption: 'VaultDedicatedInstanceEncryption',
+    ) -> None:
+        """
+        Initialize a Instance object.
+
+        :param str instance_crn: The instance CRN identifier.
+        :param str plan: Instance plan name.
+        :param VaultDedicatedCluster vault_cluster: Vault cluster information for
+               Vault Dedicated instances.
+        :param VaultDedicatedInstanceEndpoints endpoints: Instance endpoints for
+               Vault Dedicated instances.
+        :param VaultDedicatedInstanceEncryption encryption: Vault encryption
+               configuration for Vault Dedicated instances.
+        """
+        self.instance_crn = instance_crn
+        self.plan = plan
+        self.vault_cluster = vault_cluster
+        self.endpoints = endpoints
+        self.encryption = encryption
+
+    @classmethod
+    def from_dict(cls, _dict: Dict) -> 'Instance':
+        """Initialize a Instance object from a json dictionary."""
+        args = {}
+        if (instance_crn := _dict.get('instance_crn')) is not None:
+            args['instance_crn'] = instance_crn
+        else:
+            raise ValueError('Required property \'instance_crn\' not present in Instance JSON')
+        if (plan := _dict.get('plan')) is not None:
+            args['plan'] = plan
+        else:
+            raise ValueError('Required property \'plan\' not present in Instance JSON')
+        if (vault_cluster := _dict.get('vault_cluster')) is not None:
+            args['vault_cluster'] = VaultDedicatedCluster.from_dict(vault_cluster)
+        else:
+            raise ValueError('Required property \'vault_cluster\' not present in Instance JSON')
+        if (endpoints := _dict.get('endpoints')) is not None:
+            args['endpoints'] = VaultDedicatedInstanceEndpoints.from_dict(endpoints)
+        else:
+            raise ValueError('Required property \'endpoints\' not present in Instance JSON')
+        if (encryption := _dict.get('encryption')) is not None:
+            args['encryption'] = VaultDedicatedInstanceEncryption.from_dict(encryption)
+        else:
+            raise ValueError('Required property \'encryption\' not present in Instance JSON')
+        return cls(**args)
+
+    @classmethod
+    def _from_dict(cls, _dict):
+        """Initialize a Instance object from a json dictionary."""
+        return cls.from_dict(_dict)
+
+    def to_dict(self) -> Dict:
+        """Return a json dictionary representing this model."""
+        _dict = {}
+        if hasattr(self, 'instance_crn') and self.instance_crn is not None:
+            _dict['instance_crn'] = self.instance_crn
+        if hasattr(self, 'plan') and self.plan is not None:
+            _dict['plan'] = self.plan
+        if hasattr(self, 'vault_cluster') and self.vault_cluster is not None:
+            if isinstance(self.vault_cluster, dict):
+                _dict['vault_cluster'] = self.vault_cluster
+            else:
+                _dict['vault_cluster'] = self.vault_cluster.to_dict()
+        if hasattr(self, 'endpoints') and self.endpoints is not None:
+            if isinstance(self.endpoints, dict):
+                _dict['endpoints'] = self.endpoints
+            else:
+                _dict['endpoints'] = self.endpoints.to_dict()
+        if hasattr(self, 'encryption') and self.encryption is not None:
+            if isinstance(self.encryption, dict):
+                _dict['encryption'] = self.encryption
+            else:
+                _dict['encryption'] = self.encryption.to_dict()
+        return _dict
+
+    def _to_dict(self):
+        """Return a json dictionary representing this model."""
+        return self.to_dict()
+
+    def __str__(self) -> str:
+        """Return a `str` version of this Instance object."""
+        return json.dumps(self.to_dict(), indent=2)
+
+    def __eq__(self, other: 'Instance') -> bool:
+        """Return `true` when self and other are equal, false otherwise."""
+        if not isinstance(other, self.__class__):
+            return False
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other: 'Instance') -> bool:
+        """Return `true` when self and other are not equal, false otherwise."""
+        return not self == other
+
+    class PlanEnum(str, Enum):
+        """
+        Instance plan name.
+        """
+
+        DEDICATED = 'dedicated'
+
+
+
+class Token:
+    """
+    Admin Token response.
+
+    :param str token: The token value.
+    """
+
+    def __init__(
+        self,
+        token: str,
+    ) -> None:
+        """
+        Initialize a Token object.
+
+        :param str token: The token value.
+        """
+        self.token = token
+
+    @classmethod
+    def from_dict(cls, _dict: Dict) -> 'Token':
+        """Initialize a Token object from a json dictionary."""
+        args = {}
+        if (token := _dict.get('token')) is not None:
+            args['token'] = token
+        else:
+            raise ValueError('Required property \'token\' not present in Token JSON')
+        return cls(**args)
+
+    @classmethod
+    def _from_dict(cls, _dict):
+        """Initialize a Token object from a json dictionary."""
+        return cls.from_dict(_dict)
+
+    def to_dict(self) -> Dict:
+        """Return a json dictionary representing this model."""
+        _dict = {}
+        if hasattr(self, 'token') and self.token is not None:
+            _dict['token'] = self.token
+        return _dict
+
+    def _to_dict(self):
+        """Return a json dictionary representing this model."""
+        return self.to_dict()
+
+    def __str__(self) -> str:
+        """Return a `str` version of this Token object."""
+        return json.dumps(self.to_dict(), indent=2)
+
+    def __eq__(self, other: 'Token') -> bool:
+        """Return `true` when self and other are equal, false otherwise."""
+        if not isinstance(other, self.__class__):
+            return False
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other: 'Token') -> bool:
+        """Return `true` when self and other are not equal, false otherwise."""
+        return not self == other
+
+
+class VaultDedicatedCluster:
+    """
+    Vault cluster information for Vault Dedicated instances.
+
+    :param str status: Vault cluster status. Possible values:
+          - sealed: The Vault cluster is sealed and requires unsealing to access secrets
+          - not_initialized: The Vault cluster has not been initialized yet
+          - healthy: The Vault cluster is operational and ready to serve requests.
+    :param str version: Vault cluster version.
+    """
+
+    def __init__(
+        self,
+        status: str,
+        version: str,
+    ) -> None:
+        """
+        Initialize a VaultDedicatedCluster object.
+
+        :param str status: Vault cluster status. Possible values:
+               - sealed: The Vault cluster is sealed and requires unsealing to access
+               secrets
+               - not_initialized: The Vault cluster has not been initialized yet
+               - healthy: The Vault cluster is operational and ready to serve requests.
+        :param str version: Vault cluster version.
+        """
+        self.status = status
+        self.version = version
+
+    @classmethod
+    def from_dict(cls, _dict: Dict) -> 'VaultDedicatedCluster':
+        """Initialize a VaultDedicatedCluster object from a json dictionary."""
+        args = {}
+        if (status := _dict.get('status')) is not None:
+            args['status'] = status
+        else:
+            raise ValueError('Required property \'status\' not present in VaultDedicatedCluster JSON')
+        if (version := _dict.get('version')) is not None:
+            args['version'] = version
+        else:
+            raise ValueError('Required property \'version\' not present in VaultDedicatedCluster JSON')
+        return cls(**args)
+
+    @classmethod
+    def _from_dict(cls, _dict):
+        """Initialize a VaultDedicatedCluster object from a json dictionary."""
+        return cls.from_dict(_dict)
+
+    def to_dict(self) -> Dict:
+        """Return a json dictionary representing this model."""
+        _dict = {}
+        if hasattr(self, 'status') and self.status is not None:
+            _dict['status'] = self.status
+        if hasattr(self, 'version') and self.version is not None:
+            _dict['version'] = self.version
+        return _dict
+
+    def _to_dict(self):
+        """Return a json dictionary representing this model."""
+        return self.to_dict()
+
+    def __str__(self) -> str:
+        """Return a `str` version of this VaultDedicatedCluster object."""
+        return json.dumps(self.to_dict(), indent=2)
+
+    def __eq__(self, other: 'VaultDedicatedCluster') -> bool:
+        """Return `true` when self and other are equal, false otherwise."""
+        if not isinstance(other, self.__class__):
+            return False
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other: 'VaultDedicatedCluster') -> bool:
+        """Return `true` when self and other are not equal, false otherwise."""
+        return not self == other
+
+    class StatusEnum(str, Enum):
+        """
+        Vault cluster status. Possible values:
+        - sealed: The Vault cluster is sealed and requires unsealing to access secrets
+        - not_initialized: The Vault cluster has not been initialized yet
+        - healthy: The Vault cluster is operational and ready to serve requests.
+        """
+
+        SEALED = 'sealed'
+        NOT_INITIALIZED = 'not_initialized'
+        HEALTHY = 'healthy'
+
+
+
+class VaultDedicatedEndpointsData:
+    """
+    Endpoint URLs for accessing the Vault Dedicated instance.
+
+    :param str vault_api: Vault API endpoint URL.
+    :param str vault_ui: Vault UI endpoint URL.
+    """
+
+    def __init__(
+        self,
+        vault_api: str,
+        vault_ui: str,
+    ) -> None:
+        """
+        Initialize a VaultDedicatedEndpointsData object.
+
+        :param str vault_api: Vault API endpoint URL.
+        :param str vault_ui: Vault UI endpoint URL.
+        """
+        self.vault_api = vault_api
+        self.vault_ui = vault_ui
+
+    @classmethod
+    def from_dict(cls, _dict: Dict) -> 'VaultDedicatedEndpointsData':
+        """Initialize a VaultDedicatedEndpointsData object from a json dictionary."""
+        args = {}
+        if (vault_api := _dict.get('vault_api')) is not None:
+            args['vault_api'] = vault_api
+        else:
+            raise ValueError('Required property \'vault_api\' not present in VaultDedicatedEndpointsData JSON')
+        if (vault_ui := _dict.get('vault_ui')) is not None:
+            args['vault_ui'] = vault_ui
+        else:
+            raise ValueError('Required property \'vault_ui\' not present in VaultDedicatedEndpointsData JSON')
+        return cls(**args)
+
+    @classmethod
+    def _from_dict(cls, _dict):
+        """Initialize a VaultDedicatedEndpointsData object from a json dictionary."""
+        return cls.from_dict(_dict)
+
+    def to_dict(self) -> Dict:
+        """Return a json dictionary representing this model."""
+        _dict = {}
+        if hasattr(self, 'vault_api') and self.vault_api is not None:
+            _dict['vault_api'] = self.vault_api
+        if hasattr(self, 'vault_ui') and self.vault_ui is not None:
+            _dict['vault_ui'] = self.vault_ui
+        return _dict
+
+    def _to_dict(self):
+        """Return a json dictionary representing this model."""
+        return self.to_dict()
+
+    def __str__(self) -> str:
+        """Return a `str` version of this VaultDedicatedEndpointsData object."""
+        return json.dumps(self.to_dict(), indent=2)
+
+    def __eq__(self, other: 'VaultDedicatedEndpointsData') -> bool:
+        """Return `true` when self and other are equal, false otherwise."""
+        if not isinstance(other, self.__class__):
+            return False
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other: 'VaultDedicatedEndpointsData') -> bool:
+        """Return `true` when self and other are not equal, false otherwise."""
+        return not self == other
+
+
+class VaultDedicatedInstanceEncryption:
+    """
+    Vault encryption configuration for Vault Dedicated instances.
+
+    :param str mode: Vault encryption mode.
+    :param str provider: (optional) Vault encryption provider (only present for
+          customer_managed mode). Valid value - 'key_protect'.
+    :param str key_crn: (optional) Vault encryption key CRN (only present for
+          customer_managed mode).
+    """
+
+    def __init__(
+        self,
+        mode: str,
+        *,
+        provider: Optional[str] = None,
+        key_crn: Optional[str] = None,
+    ) -> None:
+        """
+        Initialize a VaultDedicatedInstanceEncryption object.
+
+        :param str mode: Vault encryption mode.
+        :param str provider: (optional) Vault encryption provider (only present for
+               customer_managed mode). Valid value - 'key_protect'.
+        :param str key_crn: (optional) Vault encryption key CRN (only present for
+               customer_managed mode).
+        """
+        self.mode = mode
+        self.provider = provider
+        self.key_crn = key_crn
+
+    @classmethod
+    def from_dict(cls, _dict: Dict) -> 'VaultDedicatedInstanceEncryption':
+        """Initialize a VaultDedicatedInstanceEncryption object from a json dictionary."""
+        args = {}
+        if (mode := _dict.get('mode')) is not None:
+            args['mode'] = mode
+        else:
+            raise ValueError('Required property \'mode\' not present in VaultDedicatedInstanceEncryption JSON')
+        if (provider := _dict.get('provider')) is not None:
+            args['provider'] = provider
+        if (key_crn := _dict.get('key_crn')) is not None:
+            args['key_crn'] = key_crn
+        return cls(**args)
+
+    @classmethod
+    def _from_dict(cls, _dict):
+        """Initialize a VaultDedicatedInstanceEncryption object from a json dictionary."""
+        return cls.from_dict(_dict)
+
+    def to_dict(self) -> Dict:
+        """Return a json dictionary representing this model."""
+        _dict = {}
+        if hasattr(self, 'mode') and self.mode is not None:
+            _dict['mode'] = self.mode
+        if hasattr(self, 'provider') and self.provider is not None:
+            _dict['provider'] = self.provider
+        if hasattr(self, 'key_crn') and self.key_crn is not None:
+            _dict['key_crn'] = self.key_crn
+        return _dict
+
+    def _to_dict(self):
+        """Return a json dictionary representing this model."""
+        return self.to_dict()
+
+    def __str__(self) -> str:
+        """Return a `str` version of this VaultDedicatedInstanceEncryption object."""
+        return json.dumps(self.to_dict(), indent=2)
+
+    def __eq__(self, other: 'VaultDedicatedInstanceEncryption') -> bool:
+        """Return `true` when self and other are equal, false otherwise."""
+        if not isinstance(other, self.__class__):
+            return False
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other: 'VaultDedicatedInstanceEncryption') -> bool:
+        """Return `true` when self and other are not equal, false otherwise."""
+        return not self == other
+
+    class ModeEnum(str, Enum):
+        """
+        Vault encryption mode.
+        """
+
+        CUSTOMER_MANAGED = 'customer_managed'
+        SERVICE_MANAGED = 'service_managed'
+
+
+
+class VaultDedicatedInstanceEndpoints:
+    """
+    Instance endpoints for Vault Dedicated instances.
+
+    :param VaultDedicatedEndpointsData public: (optional) Endpoint URLs for
+          accessing the Vault Dedicated instance.
+    :param VaultDedicatedEndpointsData private: Endpoint URLs for accessing the
+          Vault Dedicated instance.
+    """
+
+    def __init__(
+        self,
+        private: 'VaultDedicatedEndpointsData',
+        *,
+        public: Optional['VaultDedicatedEndpointsData'] = None,
+    ) -> None:
+        """
+        Initialize a VaultDedicatedInstanceEndpoints object.
+
+        :param VaultDedicatedEndpointsData private: Endpoint URLs for accessing the
+               Vault Dedicated instance.
+        :param VaultDedicatedEndpointsData public: (optional) Endpoint URLs for
+               accessing the Vault Dedicated instance.
+        """
+        self.public = public
+        self.private = private
+
+    @classmethod
+    def from_dict(cls, _dict: Dict) -> 'VaultDedicatedInstanceEndpoints':
+        """Initialize a VaultDedicatedInstanceEndpoints object from a json dictionary."""
+        args = {}
+        if (public := _dict.get('public')) is not None:
+            args['public'] = VaultDedicatedEndpointsData.from_dict(public)
+        if (private := _dict.get('private')) is not None:
+            args['private'] = VaultDedicatedEndpointsData.from_dict(private)
+        else:
+            raise ValueError('Required property \'private\' not present in VaultDedicatedInstanceEndpoints JSON')
+        return cls(**args)
+
+    @classmethod
+    def _from_dict(cls, _dict):
+        """Initialize a VaultDedicatedInstanceEndpoints object from a json dictionary."""
+        return cls.from_dict(_dict)
+
+    def to_dict(self) -> Dict:
+        """Return a json dictionary representing this model."""
+        _dict = {}
+        if hasattr(self, 'public') and self.public is not None:
+            if isinstance(self.public, dict):
+                _dict['public'] = self.public
+            else:
+                _dict['public'] = self.public.to_dict()
+        if hasattr(self, 'private') and self.private is not None:
+            if isinstance(self.private, dict):
+                _dict['private'] = self.private
+            else:
+                _dict['private'] = self.private.to_dict()
+        return _dict
+
+    def _to_dict(self):
+        """Return a json dictionary representing this model."""
+        return self.to_dict()
+
+    def __str__(self) -> str:
+        """Return a `str` version of this VaultDedicatedInstanceEndpoints object."""
+        return json.dumps(self.to_dict(), indent=2)
+
+    def __eq__(self, other: 'VaultDedicatedInstanceEndpoints') -> bool:
+        """Return `true` when self and other are equal, false otherwise."""
+        if not isinstance(other, self.__class__):
+            return False
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other: 'VaultDedicatedInstanceEndpoints') -> bool:
+        """Return `true` when self and other are not equal, false otherwise."""
+        return not self == other

ibm_secrets_manager_sdk_instance_management/version.py

@@ -0,0 +1 @@
+__version__ = '2.0.1'