README.md

IBM Cloud Secrets Manager Python SDK

A Python client library to interact with the IBM Cloud® Secrets Manager APIs.

Table of Contents

• Overview
• Prerequisites
• Installation
• Authentication
• Using the SDK
• Questions
• Issues
• Contributing
• License

Overview

The IBM Cloud Secrets Manager Python SDK allows developers to programmatically interact with the following IBM Cloud services:

Service name	Imported class name
Secrets Manager	SecretsManagerV1

Prerequisites

• An IBM Cloud account.
• A Secrets Manager service instance.
• An IBM Cloud API key that allows the SDK to access your account.
• Python 3.9 or above.

Installation

To install, use pip or easy_install:

pip install --upgrade "ibm-secrets-manager-sdk"

or

easy_install --upgrade "ibm-secrets-manager-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. Import authenticators from ibm_cloud_sdk_core.authenticators.

Examples

Programmatic credentials

from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator

secretsManager = SecretsManagerV1(
    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.

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 page in the Secrets Manager UI.

Examples

Construct a service client and use it to create and retrieve a secret from your Secrets Manager instance.

Here's an example secrets_manager.py file:

from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator
from ibm_secrets_manager_sdk.secrets_manager_v1 import *

secretsManager = SecretsManagerV1(
    authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>')
)

secretsManager.set_service_url('<SERVICE_URL>')

# create arbitrary secret
response = secretsManager.create_secret(
    'arbitrary',
    {'collection_type': 'application/vnd.ibm.secrets-manager.secret+json', 'collection_total': 1},
    [{'name': 'example-arbitrary-secret', 'description': 'Extended description for this secret.',
      'payload': 'secret-data'}]
)

secretId = response.result['resources'][0]['id']

# get arbitrary secret
response = secretsManager.get_secret(
    'arbitrary',
    secretId
)

secretPayload = response.result['resources'][0]['secret_data']['payload']
print('The arbitrary secret payload is: ' + secretPayload)

Replace the apikey and set_service_url() values. Then use the python secrets_manager.py command to run your application. You should see the payload of the arbitrary secret that was created.

For more information and IBM Cloud SDK usage examples for Python, see the IBM Cloud SDK Common documentation.

Questions

If you're having difficulties using this SDK, you can ask questions about this project by using Stack Overflow. Be sure to include the ibm-cloud and ibm-secrets-manager tags.

You can also check out the Secrets Manager documentation and API reference for more information about the service.

Issues

If you encounter an issue with the project, you're welcome to submit a bug report to help us improve.

Contributing

For general contribution guidelines, see CONTRIBUTING.

License

This SDK project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.

dummy_PR #1