Skip to main content

IBM Cloud Secrets Manager Python SDK

Project description

IBM Cloud Secrets Manager Python SDK

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

Table of Contents

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 SecretsManagerV2

Prerequisites

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 = SecretsManagerV2(
    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_v2 import *

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

secretsManager.set_service_url('<SERVICE_URL>')

# create arbitrary secret
secret_prototype_model = {
    'custom_metadata': {'metadata_custom_key':'metadata_custom_value'},
    'description': 'Description of my arbitrary secret.',
    'expiration_date': '2030-10-05T11:49:42Z',
    'labels': ['dev', 'us-south'],
    'name': 'example-arbitrary-secret',
    'secret_group_id': 'default',
    'secret_type': 'arbitrary',
    'payload': 'secret-data',
    'version_custom_metadata': {'custom_version_key':'custom_version_value'},
}

response = secretsManager.create_secret(
  secret_prototype=secret_prototype_model,
)

secretId = response.result['id']

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

secretPayload = response.result['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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ibm-secrets-manager-sdk-2.1.3.tar.gz (120.3 kB view details)

Uploaded Source

Built Distribution

ibm_secrets_manager_sdk-2.1.3-py3-none-any.whl (122.5 kB view details)

Uploaded Python 3

File details

Details for the file ibm-secrets-manager-sdk-2.1.3.tar.gz.

File metadata

File hashes

Hashes for ibm-secrets-manager-sdk-2.1.3.tar.gz
Algorithm Hash digest
SHA256 efe80cb9d532f15d30b20f53aa6a36b3edd1aa5d29713fc7911fa8f8daf83bb2
MD5 1336fb57ef97f12ab07b1e91f8460e70
BLAKE2b-256 4602db0a75d6d3c9bc8889e7298af908f542b6539609cd278b3b8facd30f71e0

See more details on using hashes here.

File details

Details for the file ibm_secrets_manager_sdk-2.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for ibm_secrets_manager_sdk-2.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b4693ef52f6811e433ede100260515692d6c491633acfeffe8eca8d776b8de62
MD5 7c0ae71fcf7c8bc55c06b8d75d0e4cc5
BLAKE2b-256 c685e1c6b4967b0cd43b42470d5dd1dd9b304afa58c155347695653e0e27b58d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page