{ "openapi": "3.0.0", "servers": [ { "url": "https://{instance_id}.{region}.secrets-manager.appdomain.cloud", "variables": { "instance_id": { "default": "provide-here-your-smgr-instanceuuid", "description": "The Secrets Manager Instance ID assigned by the service provider" }, "region": { "default": "us-south", "description": "The region where you provisioned your Secrets Manager Instance. Available values: us-south, us-east, au-syd, jp-osa, jp-tok, eu-de, eu-gb, eu-es, ca-tor, ca-mon, br-sao, in-che" } } }, { "url": "https://{instance_id}.{region}.secrets-manager.test.appdomain.cloud", "variables": { "instance_id": { "default": "provide-here-your-smgr-instanceuuid", "description": "The Secrets Manager Instance ID assigned by the service provider" }, "region": { "default": "us-south", "description": "The region where you provisioned your Secrets Manager Instance. Available values: us-south, eu-gb" } } }, { "url": "/" } ], "info": { "title": "IBM Cloud Secrets Manager API", "x-alternate-name": "secrets-manager", "version": "2.0.0", "x-ibm-name": "secrets-manager", "description": "## Introduction\n\nWith IBM Cloud® Secrets Manager, you can create, lease, and centrally manage secrets that are used in IBM Cloud services or your custom-built applications. Secrets are stored in a dedicated instance of Secrets Manager that is built on open source HashiCorp Vault.\n\nSDKs for Java, Node, Python, and Go are available to make it easier to programmatically access the API from your code. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. The tab for each language includes code examples that demonstrate how to use the client libraries. \n\nFor more information about using the SDKs, see the [IBM Cloud SDK Common project](https://github.com/IBM/ibm-cloud-sdk-common) on GitHub. For more information about getting started with Secrets Manager, check out the [docs](https://cloud.ibm.com/docs/secrets-manager).\n\nInstalling the Java SDK\n\nMaven\n\n```xml\n\n com.ibm.cloud\n secrets-manager-sdk\n ${version}\n\n```\n\nGradle\n\n```java\ncompile 'com.ibm.cloud:secrets-manager-sdk:${version}'\n```\n\nReplace `{version}` in these examples with the release version.\n\nView on GitHub\n\nhttps://github.com/IBM/secrets-manager-java-sdk\n\nInstalling the Python SDK\n\n```bash\npip install --upgrade \"ibm-secrets-manager-sdk\"\n```\n\nView on GitHub\n\nhttps://github.com/IBM/secrets-manager-python-sdk\n\nInstalling the Go SDK\n\nGo modules (recommended): Add the following import in your code, and then run `go build` or `go mod tidy`\n\n```go\nimport (\n sm \"github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2\"\n)\n```\n\nGo get\n\n```bash\ngo get -u github.com/IBM/secrets-manager-go-sdk/v2\n```\n\nView on GitHub\n\nhttps://github.com/IBM/secrets-manager-go-sdk\n\nInstalling the Node SDK\n\n```bash\nnpm install @ibm-cloud/secrets-manager\n```\n\nView on GitHub\n\nhttps://github.com/IBM/secrets-manager-node-sdk\n\n## Endpoint URLs\n\nSecrets Manager supports instance-specific endpoint URLs that you can use to interact with the service over [public or private service endpoints](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-endpoints#service-endpoints). To make requests to the API, you supply the instance ID that is unique to your Secrets Manager service instance.\n\nYou can copy your endpoint URL from the **Endpoints** page in the Secrets Manager service dashboard.\n\n**Endpoint URLs by location**\n\n- Chennai: `https://{instance_ID}.in-che.secrets-manager.appdomain.cloud` \n- Dallas: `https://{instance_ID}.us-south.secrets-manager.appdomain.cloud`\n- Frankfurt: `https://{instance_ID}.eu-de.secrets-manager.appdomain.cloud`\n- London: `https://{instance_ID}.eu-gb.secrets-manager.appdomain.cloud`\n- Madrid: `https://{instance_ID}.eu-es.secrets-manager.appdomain.cloud`\n- Osaka: `https://{instance_ID}.jp-osa.secrets-manager.appdomain.cloud`\n- Sao Paulo: `https://{instance_ID}.br-sao.secrets-manager.appdomain.cloud`\n- Sydney: `https://{instance_ID}.au-syd.secrets-manager.appdomain.cloud`\n- Tokyo: `https://{instance_ID}.jp-tok.secrets-manager.appdomain.cloud`\n- Toronto: `https://{instance_ID}.ca-tor.secrets-manager.appdomain.cloud`\n- Montreal: `https://{instance_ID}.ca-mon.secrets-manager.appdomain.cloud`\n- Washington DC: `https://{instance_ID}.us-east.secrets-manager.appdomain.cloud`\n\nSecrets Manager supports instance-specific endpoint URLs that you can use to interact with the service over [public or private service endpoints](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-endpoints#service-endpoints). To target your Secrets Manager service instance by using the Java SDK, use the `setServiceUrl()` method. You can copy your endpoint URL from the **Endpoints** page in the Secrets Manager service dashboard.\n\n**Endpoint URLs by location**\n\n- Chennai - Airtel: `https://{instance_ID}.in-che.secrets-manager.appdomain.cloud` \n- Dallas: `https://{instance_ID}.us-south.secrets-manager.appdomain.cloud`\n- Frankfurt: `https://{instance_ID}.eu-de.secrets-manager.appdomain.cloud`\n- London: `https://{instance_ID}.eu-gb.secrets-manager.appdomain.cloud`\n- Madrid: `https://{instance_ID}.eu-es.secrets-manager.appdomain.cloud`\n- Osaka: `https://{instance_ID}.jp-osa.secrets-manager.appdomain.cloud`\n- Sao Paulo: `https://{instance_ID}.br-sao.secrets-manager.appdomain.cloud`\n- Sydney: `https://{instance_ID}.au-syd.secrets-manager.appdomain.cloud`\n- Tokyo: `https://{instance_ID}.jp-tok.secrets-manager.appdomain.cloud`\n- Toronto: `https://{instance_ID}.ca-tor.secrets-manager.appdomain.cloud`\n- Montreal: `https://{instance_ID}.ca-mon.secrets-manager.appdomain.cloud`\n- Washington DC: `https://{instance_ID}.us-east.secrets-manager.appdomain.cloud`\n\nSecrets Manager supports instance-specific endpoint URLs that you can use to interact with the service over [public or private service endpoints](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-endpoints#service-endpoints). To target your Secrets Manager service instance by using the Node.js SDK, use the `serviceUrl` parameter. You can copy your endpoint URL from the **Endpoints** page in the Secrets Manager service dashboard.\n\n**Endpoint URLs by location**\n\n- Chennai - Airtel: `https://{instance_ID}.in-che.secrets-manager.appdomain.cloud` \n- Dallas: `https://{instance_ID}.us-south.secrets-manager.appdomain.cloud`\n- Frankfurt: `https://{instance_ID}.eu-de.secrets-manager.appdomain.cloud`\n- London: `https://{instance_ID}.eu-gb.secrets-manager.appdomain.cloud`\n- Madrid: `https://{instance_ID}.eu-es.secrets-manager.appdomain.cloud`\n- Osaka: `https://{instance_ID}.jp-osa.secrets-manager.appdomain.cloud`\n- Sao Paulo: `https://{instance_ID}.br-sao.secrets-manager.appdomain.cloud`\n- Sydney: `https://{instance_ID}.au-syd.secrets-manager.appdomain.cloud`\n- Tokyo: `https://{instance_ID}.jp-tok.secrets-manager.appdomain.cloud`\n- Toronto: `https://{instance_ID}.ca-tor.secrets-manager.appdomain.cloud`\n- Montreal: `https://{instance_ID}.ca-mon.secrets-manager.appdomain.cloud`\n- Washington DC: `https://{instance_ID}.us-east.secrets-manager.appdomain.cloud`\n\nSecrets Manager supports instance-specific endpoint URLs that you can use to interact with the service over [public or private service endpoints](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-endpoints#service-endpoints). To target your Secrets Manager service instance by using the Python SDK, use the `set_service_url()` method. You can copy your endpoint URL from the **Endpoints** page in the Secrets Manager service dashboard.\n\n**Endpoint URLs by location**\n\n- Chennai - Airtel: `https://{instance_ID}.in-che.secrets-manager.appdomain.cloud` \n- Dallas: `https://{instance_ID}.us-south.secrets-manager.appdomain.cloud`\n- Frankfurt: `https://{instance_ID}.eu-de.secrets-manager.appdomain.cloud`\n- London: `https://{instance_ID}.eu-gb.secrets-manager.appdomain.cloud`\n- Madrid: `https://{instance_ID}.eu-es.secrets-manager.appdomain.cloud`\n- Osaka: `https://{instance_ID}.jp-osa.secrets-manager.appdomain.cloud`\n- Sao Paulo: `https://{instance_ID}.br-sao.secrets-manager.appdomain.cloud`\n- Sydney: `https://{instance_ID}.au-syd.secrets-manager.appdomain.cloud`\n- Tokyo: `https://{instance_ID}.jp-tok.secrets-manager.appdomain.cloud`\n- Toronto: `https://{instance_ID}.ca-tor.secrets-manager.appdomain.cloud`\n- Montreal: `https://{instance_ID}.ca-mon.secrets-manager.appdomain.cloud`\n- Washington DC: `https://{instance_ID}.us-east.secrets-manager.appdomain.cloud`\n\nSecrets Manager supports instance-specific endpoint URLs that you can use to interact with the service over [public or private service endpoints](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-endpoints#service-endpoints). To target your Secrets Manager service instance by using the Go SDK, use the `URL` parameter. You can copy your endpoint URL from the **Endpoints** page in the Secrets Manager service dashboard.\n\n**Endpoint URLs by location**\n\n- Chennai - Airtel: `https://{instance_ID}.in-che.secrets-manager.appdomain.cloud` \n- Dallas: `https://{instance_ID}.us-south.secrets-manager.appdomain.cloud`\n- Frankfurt: `https://{instance_ID}.eu-de.secrets-manager.appdomain.cloud`\n- London: `https://{instance_ID}.eu-gb.secrets-manager.appdomain.cloud`\n- Madrid: `https://{instance_ID}.eu-es.secrets-manager.appdomain.cloud`\n- Osaka: `https://{instance_ID}.jp-osa.secrets-manager.appdomain.cloud`\n- Sao Paulo: `https://{instance_ID}.br-sao.secrets-manager.appdomain.cloud`\n- Sydney: `https://{instance_ID}.au-syd.secrets-manager.appdomain.cloud`\n- Tokyo: `https://{instance_ID}.jp-tok.secrets-manager.appdomain.cloud`\n- Toronto: `https://{instance_ID}.ca-tor.secrets-manager.appdomain.cloud`\n- Montreal: `https://{instance_ID}.ca-mon.secrets-manager.appdomain.cloud`\n- Washington DC: `https://{instance_ID}.us-east.secrets-manager.appdomain.cloud`\n\nBase URL\n```\nhttps://{instance_ID}.{region}.secrets-manager.appdomain.cloud\n```\n\nExample for the Dallas location\n\n```java\nimport com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2.SecretsManager;\nimport com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2.model.*;\nimport com.ibm.cloud.sdk.core.http.Response;\nimport com.ibm.cloud.sdk.core.security.IamAuthenticator;\n\nimport java.util.Collections;\n...\n\n// Create an IAM authenticator\nIamAuthenticator iamAuthenticator = new IamAuthenticator.Builder()\n .apikey(\"\")\n .build();\n\n// Construct the service client\nSecretsManager secretsManagerService = new SecretsManager(\"My Secrets-Manager service\", iamAuthenticator);\n\n// Set the service URL\nsecretsManagerService.setServiceUrl(\"https://{instance_ID}.us-south.secrets-manager.appdomain.cloud\");\n```\n\nExample for the Dallas location\n\n```javascript\nconst IbmCloudSecretsManagerApiV2 = require('@ibm-cloud/secrets-manager/secrets-manager/v2');\nconst { IamAuthenticator } = require('@ibm-cloud/secrets-manager/auth');\n\nconst secretsManagerService = new SecretsManagerV2({\n authenticator: new IamAuthenticator({\n apikey: '',\n }),\n serviceUrl: 'https://{instance_ID}.us-south.secrets-manager.appdomain.cloud',\n});\n```\n\nExample for the Dallas location\n\n```python\nfrom ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator\nfrom ibm_secrets_manager_sdk.secrets_manager_v2 import *\n\nsecrets_manager_service = SecretsManagerV2(\n authenticator=IAMAuthenticator(apikey='')\n)\n\nsecrets_manager_service.set_service_url('https://{instance_ID}.us-south.secrets-manager.appdomain.cloud')\n```\n\nExample for the Dallas location\n\n```go\nimport (\n \"encoding/json\"\n \"fmt\"\n \"github.com/IBM/go-sdk-core/v5/core\"\n sm \"github.com/IBM/secrets-manager-go-sdk/secretsmanagerv2\"\n)\n\nfunc main() {\n\n secretsManagerService, err := sm.NewSecretsManagerV2(&sm.SecretsManagerV2Options {\n URL: \"https://{instance_ID}.us-south.secrets-manager.appdomain.cloud\",\n Authenticator: & core.IamAuthenticator {\n ApiKey: \"\",\n },\n })\n\n if err != nil {\n panic(err)\n }\n}\n```\n\n## Authentication\n\nAuthorization to the Secrets Manager API is enforced by using an IBM Cloud Identity and Access Management (IAM) access token. The token is used to determine the actions that a user or service ID has access to when they use the API.\n\nTo work with the API, include a valid IAM token in each outgoing request to the service. You can generate an access token by first [creating an API key](https://cloud.ibm.com/docs/account?topic=account-iamtoken_from_apikey) and then exchanging your API key for an IBM Cloud IAM token.\n\nDon't have an API key? Try running `ibmcloud iam oauth-tokens` in the [IBM Cloud Shell](https://cloud.ibm.com/shell) to quickly generate a personal access token.\n\nTo generate an access token from your API key, use the following cURL command.\n\n```bash\ncurl -X POST \\\n \"https://iam.cloud.ibm.com/identity/token\" \\\n --header 'Content-Type: application/x-www-form-urlencoded' \\\n --header 'Accept: application/json' \\\n --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey' \\\n --data-urlencode 'apikey='\n```\n\nReplace `` with your IBM Cloud API key.\n\nWhen you use the SDK, configure an IAM authenticator with an IBM Cloud IAM API key. The authenticator automatically obtains the IAM access token for the API key and includes it with each request. You can configure an authenticator in either of two ways:\n\n- Programmatically by constructing an IAM authenticator instance and supplying your IAM API key\n- By defining the API key in external configuration properties and then using the SDK authenticator factory to construct an IAM authenticator that uses the configured IAM API key\n\nFor more information, see the Authentication section of the [IBM Cloud SDK Common](https://github.com/IBM/ibm-cloud-sdk-common/blob/main/README.md#authentication) documentation.\n\nExample API request\n\n```bash\ncurl -X {request_method} \"{base_url}/api/v2/{method_endpoint}\" --header \"Authorization: Bearer {IAM_token}\"\n```\n\nReplace `{IAM_token}` with your access token.\n\nConstructing the service client\n\n```java\nimport com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2.SecretsManager;\nimport com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2.model.*;\nimport com.ibm.cloud.sdk.core.http.Response;\nimport com.ibm.cloud.sdk.core.security.IamAuthenticator;\n\nimport java.util.Collections;\n...\n\n// Create an IAM authenticator\nIamAuthenticator iamAuthenticator = new IamAuthenticator.Builder()\n .apikey(\"\")\n .build();\n\n// Construct the service client\nSecretsManager secretsManagerService = new SecretsManager(\"My Secrets-Manager service\", iamAuthenticator);\n\n// Set the service URL\nsecretsManagerService.setServiceUrl(\"\");\n```\n\nReplace `` with your IBM Cloud API key. Replace `` with the endpoint URL for your instance. Invoke service operations by using the `secretsManagerService` variable.\n\nConstructing the service client\n\n```python\nfrom ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator\nfrom ibm_secrets_manager_sdk.secrets_manager_v2 import *\n\nsecrets_manager_service = SecretsManagerV2(\n authenticator=IAMAuthenticator(apikey='')\n)\n\nsecrets_manager_service.set_service_url('')\n```\n\nReplace `` with your IBM Cloud API key. Replace `` with the endpoint URL for your instance.\n\nConstructing the service client\n\n```go\nimport (\n \"encoding/json\"\n \"fmt\"\n \"github.com/IBM/go-sdk-core/v5/core\"\n sm \"github.com/IBM/secrets-manager-go-sdk/secretsmanagerv2\"\n)\n\nfunc main() {\n\n secretsManagerService, err := sm.NewSecretsManagerV2(&sm.SecretsManagerV2Options {\n URL: \"\",\n Authenticator: & core.IamAuthenticator {\n ApiKey: \"\",\n },\n })\n\n if err != nil {\n panic(err)\n }\n}\n```\n\nReplace `` with your IBM Cloud API key. Replace `` with the endpoint URL for your instance.\n\nConstructing the service client\n\n```javascript\nconst IbmCloudSecretsManagerApiV2 = require('@ibm-cloud/secrets-manager/secrets-manager/v2');\nconst { IamAuthenticator } = require('@ibm-cloud/secrets-manager/auth');\n\nconst secretsManagerService = new IbmCloudSecretsManagerApiV2({\n authenticator: new IamAuthenticator({\n apikey: '',\n }),\n serviceUrl: '',\n});\n```\n\nReplace `` with your IBM Cloud API key. Replace `` with the endpoint URL for your instance.\n\n## Auditing\n\nYou can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method.\n\nFor more information about how to track Secrets Manager activity, see [Auditing events for Secrets Manager](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-at_events).\n\n## Error handling\n\nThe Secrets Manager APIs use standard [HTTP status codes](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-status-codes) to indicate whether a method completed successfully. HTTP response codes in the `2xx` range indicate success. A response in the `4xx` range is some sort of failure, and a response in the `5xx` range usually indicates an internal system error.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Status code summary
Status codeDescription
200\n OKEverything worked as expected.
300\n Multiple ChoicesThe request has more than one possible responses.
400\n Bad RequestThe request was unsuccessful, often due to a missing required parameter.
401\n UnauthorizedAccess token is missing or invalid.
402\n Payment RequiredYour Trial plan is now expired.
403\n ForbiddenYou are not allowed to access this resource.
404\n Not FoundThe requested resource doesn't exist.
409\n ConflictThe requested resource conflicts with an already existing resource.
410\n GoneThe requested resource was deleted and no longer exists.
429\n Too Many RequestsToo many requests hit the API too quickly.
500\n Internal Server ErrorSomething went wrong on Secrets Manager's end.
\n\nExample error handling\n\n```javascript\nsecretsManagerApi.method(params)\n .catch(err => {\n console.log('Error:', err);\n });\n```\n\nExample error handling\n\n```go\nimport sm \"github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2\"\n\n// Instantiate a service\nsecretsManagerApi, err := sm.NewSecretsManagerV2(&sm.SecretsManagerV2Options)\n\n// Check for errors\nif err != nil {\n panic(err)\n}\n\n// Call a method\nresult, response, err := secretsManagerApi.MethodName(&methodOptions)\n\n// Check for errors\nif err != nil {\n panic(err)\n}\n```\n\n## Pagination\n\nSome API requests might return a large number of results. To avoid performance issues, the Secrets Manager API returns one page of results at a time, with a limited number of results on each page.\n\nThe default page size is defined differently for each operation. To use a different page size, use the `limit` query parameter.\n\n## Rate limiting\n\nSecrets Manager API does not enforce a hard rate-limit. However as requests rate increase, some performance degradation is expected. The impact depends on the requests patterns. As a rule of thumb it is recommended to keep the rate up to 20 requests per second.\n\n## Change log\n\nFor the latest changes, improvements, and updates for this API, see the [API change log](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-api-change-log).", "x-cli-description": "Use the IBM Cloud® Secrets Manager service to create and manage secrets that are used in other IBM Cloud services or your custom-built applications.", "x-codegen-config": { "go": { "apiPackage": "github.com/IBM/secrets-manager-go-sdk/v2" }, "java": { "apiPackage": "com.ibm.cloud.secrets_manager_sdk" }, "python": { "apiPackage": "ibm_secrets_manager_sdk" }, "cli": { "apiPackage": "secrets-manager", "cliPluginName": "secrets-manager", "confirmDeleteOperations": true, "extendUtilities": true, "privateEndpointSupported": true, "serviceCommandAliases": [ "sm" ], "singleServicePlugin": true, "createServiceUrlFlag": true }, "terraform": null }, "x-github": "https://github.ibm.com/cloud-api-docs/secrets-manager", "x-github-issues": "https://github.ibm.com/cloud-api-docs/secrets-manager/issues/new", "x-last-updated": "2022-12-09" }, "security": [ { "BearerAuth": [] } ], "externalDocs": { "description": "For more information about this service, see the docs.", "url": "https://cloud.ibm.com/docs/secrets-manager", "x-cli-ref-url": "https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secrets-manager-cli" }, "tags": [ { "name": "Secret groups", "description": "Control who can access secrets by creating and managing groups." }, { "name": "Secrets", "description": "Create, order, and manage different types of secrets for your apps and services." }, { "name": "Secret versions", "description": "Create and manage the versions of your secrets." }, { "name": "Secret tasks", "description": "Monitor and Update the tasks that belong to your secret." }, { "name": "Secret locks", "description": "Secure your secret data by attaching a lock to a secret version and preventing any modification or deletion." }, { "name": "Configurations", "description": "Create and manage configurations so that you can work with specific types of secrets." }, { "name": "Notifications", "description": "Enable lifecycle notifications for your instance by connecting to Event Notifications." } ], "paths": { "/api/v2/secret_groups": { "post": { "summary": "Create a new secret group", "x-codegen-request-body-name": "SecretGroupPrototype", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-group", "description": "Create a secret group", "action": "secrets-manager.secret-group.create", "targetResourceType": "secret-group" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-group.create" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-group.create" } ] }, "tags": [ "Secret groups" ], "description": "Create a secret group that you can use to organize secrets and control who can access them.\n\nA successful request returns the ID value of the secret group, along with other properties. To learn more about\nsecret groups, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-groups).", "x-cli-description": "Create a secret group to organize secrets and control who can access them.", "operationId": "create_secret_group", "requestBody": { "description": "The request body to create a new secret group.\n", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretGroupPrototype" } } } }, "responses": { "201": { "description": "The secret group was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretGroup" }, "examples": { "SecretGroup": { "$ref": "#/components/examples/SecretGroup" } } } }, "links": { "SecretGroupIdForGetSecretGroup": { "$ref": "#/components/links/SecretGroupIdForGetSecretGroup" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\"name\":\"my-secret-group\",\"description\":\"Extended description for this group.\"}' \\\n", " \"/api/v2/secret_groups\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "CreateSecretGroupOptions createSecretGroupOptions = new CreateSecretGroupOptions.Builder()\n", " .name(\"my-secret-group\")\n", " .build();\n", "\n", "Response response = secretsManagerService.createSecretGroup(createSecretGroupOptions).execute();\n", "SecretGroup secretGroup = response.getResult();\n", "\n", "System.out.println(secretGroup);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " name: 'my-secret-group',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.createSecretGroup(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.create_secret_group(\n", " name='my-secret-group',\n", ")\n", "secret_group = response.get_result()\n", "\n", "print(json.dumps(secret_group, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "createSecretGroupOptions := secretsManagerService.NewCreateSecretGroupOptions(\n", " \"my-secret-group\",\n", ")\n", "\n", "secretGroup, response, err := secretsManagerService.CreateSecretGroup(createSecretGroupOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretGroup, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "get": { "summary": "List secret groups", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-groups", "description": "List secret groups", "action": "secrets-manager.secret-groups.list" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-groups.list" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-groups.list" } ] }, "tags": [ "Secret groups" ], "description": "List the secret groups that are available in your Secrets Manager instance.", "x-cli-description": "List the secret groups that are available in your Secrets Manager instance.", "operationId": "list_secret_groups", "x-cli-table-filter-jmespath": "secret_groups[*]", "responses": { "200": { "description": "The list of secret groups was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretGroupCollection" }, "examples": { "SecretGroupCollection": { "$ref": "#/components/examples/SecretGroupCollection" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secret_groups\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ListSecretGroupsOptions listSecretGroupsOptions = new ListSecretGroupsOptions();\n", "\n", "Response response = secretsManagerService.listSecretGroups(listSecretGroupsOptions).execute();\n", "SecretGroupCollection secretGroupCollection = response.getResult();\n", "\n", "System.out.println(secretGroupCollection);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "let res;\n", "try {\n", " res = await secretsManagerService.listSecretGroups({});\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.list_secret_groups()\n", "secret_group_collection = response.get_result()\n", "\n", "print(json.dumps(secret_group_collection, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listSecretGroupsOptions := secretsManagerService.NewListSecretGroupsOptions()\n", "\n", "secretGroupCollection, response, err := secretsManagerService.ListSecretGroups(listSecretGroupsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretGroupCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secret_groups/{id}": { "get": { "summary": "Get a secret group", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-group", "description": "View the details of a secret group.", "targetResourceType": "secret-group", "action": "secrets-manager.secret-group.read" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-group.read" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-group.read" } ] }, "tags": [ "Secret groups" ], "description": "Get the properties of an existing secret group by specifying the ID of the group.", "x-cli-description": "Get the properties of a secret group.", "operationId": "get_secret_group", "parameters": [ { "$ref": "#/components/parameters/SecretGroupId" } ], "responses": { "200": { "description": "The secret group was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretGroup" }, "examples": { "SecretGroup": { "$ref": "#/components/examples/SecretGroup" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secret_groups/secretGroupIdForGetSecretGroupLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "GetSecretGroupOptions getSecretGroupOptions = new GetSecretGroupOptions.Builder()\n", " .id(secretGroupIdForGetSecretGroupLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.getSecretGroup(getSecretGroupOptions).execute();\n", "SecretGroup secretGroup = response.getResult();\n", "\n", "System.out.println(secretGroup);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: secretGroupIdForGetSecretGroupLink,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.getSecretGroup(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.get_secret_group(\n", " id=secret_group_id_for_get_secret_group_link,\n", ")\n", "secret_group = response.get_result()\n", "\n", "print(json.dumps(secret_group, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getSecretGroupOptions := secretsManagerService.NewGetSecretGroupOptions(\n", " secretGroupIdForGetSecretGroupLink,\n", ")\n", "\n", "secretGroup, response, err := secretsManagerService.GetSecretGroup(getSecretGroupOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretGroup, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "patch": { "summary": "Update a secret group", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-group", "description": "Update a secret group", "targetResourceType": "secret-group", "action": "secrets-manager.secret-group.update" }, "x-codegen-request-body-name": "SecretGroupPatch", "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-group.update" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-group.update" } ] }, "tags": [ "Secret groups" ], "description": "Update the properties of an existing secret group, such as its name or description.", "x-cli-description": "Update the properties of a secret group, such as its name or description.", "operationId": "update_secret_group", "parameters": [ { "$ref": "#/components/parameters/SecretGroupIdNoDefault" } ], "requestBody": { "description": "The request body to update a secret group.\n", "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/SecretGroupPatch" } } } }, "responses": { "200": { "description": "The secret group was successfully updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretGroup" }, "examples": { "SecretGroup": { "$ref": "#/components/examples/SecretGroup" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/merge-patch+json\" \\\n", " --data '' \\\n", " \"/api/v2/secret_groups/secretGroupIdForGetSecretGroupLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "SecretGroupPatch secretGroupPatchModel = new SecretGroupPatch.Builder()\n", " .build();\n", "Map secretGroupPatchModelAsPatch = secretGroupPatchModel.asPatch();\n", "UpdateSecretGroupOptions updateSecretGroupOptions = new UpdateSecretGroupOptions.Builder()\n", " .id(secretGroupIdForGetSecretGroupLink)\n", " .secretGroupPatch(secretGroupPatchModelAsPatch)\n", " .build();\n", "\n", "Response response = secretsManagerService.updateSecretGroup(updateSecretGroupOptions).execute();\n", "SecretGroup secretGroup = response.getResult();\n", "\n", "System.out.println(secretGroup);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: secretGroupIdForGetSecretGroupLink,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.updateSecretGroup(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secret_group_patch_model = {\n", "}\n", "\n", "response = secrets_manager_service.update_secret_group(\n", " id=secret_group_id_for_get_secret_group_link,\n", " secret_group_patch=secret_group_patch_model,\n", ")\n", "secret_group = response.get_result()\n", "\n", "print(json.dumps(secret_group, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secretGroupPatchModel := &secretsmanagerv2.SecretGroupPatch{\n", "}\n", "secretGroupPatchModelAsPatch, asPatchErr := secretGroupPatchModel.AsPatch()\n", "Expect(asPatchErr).To(BeNil())\n", "\n", "updateSecretGroupOptions := secretsManagerService.NewUpdateSecretGroupOptions(\n", " secretGroupIdForGetSecretGroupLink,\n", " secretGroupPatchModelAsPatch,\n", ")\n", "\n", "secretGroup, response, err := secretsManagerService.UpdateSecretGroup(updateSecretGroupOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretGroup, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "summary": "Delete a secret group", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-group", "description": "Delete a secret group.", "targetResourceType": "secret-group", "action": "secrets-manager.secret-group.delete" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-group.delete" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-group.delete" } ] }, "tags": [ "Secret groups" ], "description": "Delete a secret group by specifying the ID of the secret group.\n\n**Note:** To delete a secret group, it must be empty. If you need to remove a secret group that contains secrets,\nyou must first delete the secrets that are associated with the group.", "x-cli-description": "Delete a secret group. To delete a group that contains secrets, be sure to first delete the secrets that are associated with the group.", "operationId": "delete_secret_group", "parameters": [ { "$ref": "#/components/parameters/SecretGroupIdNoDefault" } ], "responses": { "204": { "description": "The secret group was successfully deleted." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"/api/v2/secret_groups/secretGroupIdForGetSecretGroupLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "DeleteSecretGroupOptions deleteSecretGroupOptions = new DeleteSecretGroupOptions.Builder()\n", " .id(secretGroupIdForGetSecretGroupLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.deleteSecretGroup(deleteSecretGroupOptions).execute();" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: secretGroupIdForGetSecretGroupLink,\n", "};\n", "\n", "try {\n", " await secretsManagerService.deleteSecretGroup(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.delete_secret_group(\n", " id=secret_group_id_for_get_secret_group_link,\n", ")" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteSecretGroupOptions := secretsManagerService.NewDeleteSecretGroupOptions(\n", " secretGroupIdForGetSecretGroupLink,\n", ")\n", "\n", "response, err := secretsManagerService.DeleteSecretGroup(deleteSecretGroupOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteSecretGroup(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } } }, "/api/v2/secrets": { "post": { "summary": "Create a new secret", "x-codegen-request-body-name": "SecretPrototype", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret", "description": "Create a new secret", "action": "secrets-manager.secret.create", "targetResourceType": "secret" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret.create" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret.create" } ] }, "tags": [ "Secrets" ], "description": "Create a secret or import an existing value that you can use to access or authenticate to a protected resource.\n\nUse this operation to either generate or import an existing secret, such as a TLS certificate,\nthat you can manage in your Secrets Manager service instance. A successful request stores the secret in your\ndedicated instance, based on the secret type and data that you specify. The response returns the ID value of the\nsecret, along with other metadata.\n\nTo learn more about the types of secrets that you can create with Secrets Manager, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-what-is-secret).", "x-cli-description": "Create a secret and store it in your instance.", "operationId": "create_secret", "x-terraform-polling-operation": "get_secret", "x-terraform-polling-property": "state_description", "x-terraform-polling-success": "active", "x-terraform-polling-pending": "pre_activation", "x-terraform-polling-failure": "destroyed", "x-sdk-operations": { "request-examples": { "cli": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ibmcloud secrets-manager secret-create --secret-name=example-arbitrary-secret --secret-type=arbitrary --arbitrary-payload=example-secret-data", "\n\n", "ibmcloud secrets-manager secret-create \\\n", " --secret-prototype='{\"name\": \"example-arbitrary-secret\", \"secret_type\": \"arbitrary\", \"payload\":\"example-secret-data\"}'\n" ] } ] } ], "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"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\", \"payload\": \"secret-data\", \"secret_group_id\": \"default\", \"secret_type\": \"arbitrary\", \"version_custom_metadata\": { \"custom_version_key\": \"custom_version_value\" } }' \\\n", " \"/api/v2/secrets\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ArbitrarySecretPrototype secretPrototypeModel = new ArbitrarySecretPrototype.Builder()\n", " .description(\"Description of my arbitrary secret.\")\n", " .expirationDate(DateUtils.parseAsDateTime(\"2030-10-05T11:49:42Z\"))\n", " .labels(java.util.Arrays.asList(\"dev\", \"us-south\"))\n", " .name(\"example-arbitrary-secret\")\n", " .secretGroupId(\"default\")\n", " .secretType(\"arbitrary\")\n", " .payload(\"secret-data\")\n", " .build();\n", "CreateSecretOptions createSecretOptions = new CreateSecretOptions.Builder()\n", " .secretPrototype(secretPrototypeModel)\n", " .build();\n", "\n", "Response response = secretsManagerService.createSecret(createSecretOptions).execute();\n", "Secret secret = response.getResult();\n", "\n", "System.out.println(secret);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// ArbitrarySecretPrototype\n", "const secretPrototypeModel = {\n", " custom_metadata: { metadata_custom_key: 'metadata_custom_value' },\n", " description: 'Description of my arbitrary secret.',\n", " expiration_date: '2030-10-05T11:49:42Z',\n", " labels: ['dev', 'us-south'],\n", " name: 'example-arbitrary-secret',\n", " secret_group_id: 'default',\n", " secret_type: 'arbitrary',\n", " payload: 'secret-data',\n", " version_custom_metadata: { custom_version_key: 'custom_version_value' },\n", "};\n", "\n", "const params = {\n", " secretPrototype: secretPrototypeModel,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.createSecret(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secret_prototype_model = {\n", " 'custom_metadata': {'metadata_custom_key': 'metadata_custom_value'},\n", " 'description': 'Description of my arbitrary secret.',\n", " 'expiration_date': '2030-10-05T11:49:42Z',\n", " 'labels': ['dev', 'us-south'],\n", " 'name': 'example-arbitrary-secret',\n", " 'secret_group_id': 'default',\n", " 'secret_type': 'arbitrary',\n", " 'payload': 'secret-data',\n", " 'version_custom_metadata': {'custom_version_key': 'custom_version_value'},\n", "}\n", "\n", "response = secrets_manager_service.create_secret(\n", " secret_prototype=secret_prototype_model,\n", ")\n", "secret = response.get_result()\n", "\n", "print(json.dumps(secret, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secretPrototypeModel := &secretsmanagerv2.ArbitrarySecretPrototype{\n", " Description: core.StringPtr(\"Description of my arbitrary secret.\"),\n", " Labels: []string{\"dev\", \"us-south\"},\n", " Name: core.StringPtr(\"example-arbitrary-secret\"),\n", " SecretGroupID: core.StringPtr(\"default\"),\n", " SecretType: core.StringPtr(\"arbitrary\"),\n", " Payload: core.StringPtr(\"secret-data\"),\n", "}\n", "\n", "createSecretOptions := secretsManagerService.NewCreateSecretOptions(\n", " secretPrototypeModel,\n", ")\n", "\n", "secret, response, err := secretsManagerService.CreateSecret(createSecretOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secret, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretPrototype" }, "examples": { "ArbitrarySecretPrototype": { "$ref": "#/components/examples/ArbitrarySecretPrototype" }, "IAMCredentialsSecretServiceIDPrototype": { "$ref": "#/components/examples/IAMCredentialsSecretServiceIDPrototype" }, "ImportedCertificatePrototype": { "$ref": "#/components/examples/ImportedCertificatePrototype" }, "ImportedCertificateManagedCsrPrototype": { "$ref": "#/components/examples/ImportedCertificateManagedCsrCreatePrototype" }, "KVSecretPrototype": { "$ref": "#/components/examples/KVSecretPrototype" }, "PrivateCertificatePrototype": { "$ref": "#/components/examples/PrivateCertificatePrototype" }, "PublicCertificatePrototype": { "$ref": "#/components/examples/PublicCertificatePrototype" }, "ServiceCredentialsSecretPrototype": { "$ref": "#/components/examples/ServiceCredentialsSecretPrototype" }, "UsernamePasswordSecretPrototype": { "$ref": "#/components/examples/UsernamePasswordSecretPrototype" }, "IAMCredentialsSecretAccessGroupPrototype": { "$ref": "#/components/examples/IAMCredentialsSecretAccessGroupPrototype" }, "CustomCredentialsSecretPrototype": { "$ref": "#/components/examples/CustomCredentialsSecretPrototype" } } } } }, "responses": { "201": { "description": "The secret was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Secret" }, "examples": { "ArbitrarySecret": { "$ref": "#/components/examples/ArbitrarySecret" }, "IAMCredentialsSecret": { "$ref": "#/components/examples/IAMCredentialsSecretPrototypeResponse" }, "ImportedCertificate": { "$ref": "#/components/examples/ImportedCertificate" }, "ImportedCertificateManagedCsr": { "$ref": "#/components/examples/ImportedCertificateManagedCsrCreate" }, "KVSecret": { "$ref": "#/components/examples/KVSecret" }, "PrivateCertificate": { "$ref": "#/components/examples/PrivateCertificate" }, "PublicCertificate": { "$ref": "#/components/examples/PublicCertificateCreated" }, "ServiceCredentialsSecret": { "$ref": "#/components/examples/ServiceCredentialsSecret" }, "UsernamePasswordSecret": { "$ref": "#/components/examples/UsernamePasswordSecret" }, "CustomCredentialsSecret": { "$ref": "#/components/examples/CustomCredentialsSecretCreated" } } } }, "links": { "SecretIdForGetSecret": { "$ref": "#/components/links/SecretIdForGetSecret" }, "SecretIdForGetSecretVersion": { "$ref": "#/components/links/SecretIdForGetSecretVersion" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } } }, "get": { "summary": "List secrets", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secrets", "description": "List secrets", "action": "secrets-manager.secrets.list" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secrets.list" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secrets.list" } ] }, "tags": [ "Secrets" ], "description": "List the secrets that are available in your Secrets Manager instance.", "x-cli-description": "List the secrets that are available in your Secrets Manager instance.", "x-cli-table-filter-jmespath": "secrets[*].{Name:name,ID:id,Secret_Type:secret_type,secret_group_id:secret_group_id,State:state_description,Locks:locks_total,Expiration:expiration_date}", "operationId": "list_secrets", "parameters": [ { "$ref": "#/components/parameters/SecretCollectionOffsetParam" }, { "$ref": "#/components/parameters/SecretCollectionLimitParam" }, { "$ref": "#/components/parameters/SecretCollectionSortParam" }, { "$ref": "#/components/parameters/SecretCollectionSearchParam" }, { "$ref": "#/components/parameters/SecretCollectionGroupsParam" }, { "$ref": "#/components/parameters/SecretCollectionTypesParam" }, { "$ref": "#/components/parameters/SecretCollectionLabelsParam" } ], "responses": { "200": { "description": "The list of secrets was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretMetadataPaginatedCollection" }, "examples": { "SecretMetadataPaginatedCollection": { "$ref": "#/components/examples/SecretMetadataPaginatedCollection" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets?sort=created_at&search=example&groups=[ \\\"default\\\", \\\"cac40995-c37a-4dcb-9506-472869077634\\\" ]&secret_types=[ \\\"arbitrary\\\", \\\"kv\\\" ]&match_all_labels=[ \\\"dev\\\", \\\"us-south\\\" ]\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ListSecretsOptions listSecretsOptions = new ListSecretsOptions.Builder()\n", " .limit(Long.valueOf(\"10\"))\n", " .sort(\"created_at\")\n", " .search(\"example\")\n", " .groups(java.util.Arrays.asList(\"default\", \"cac40995-c37a-4dcb-9506-472869077634\"))\n", " .secretTypes(java.util.Arrays.asList(\"arbitrary\", \"kv\"))\n", " .matchAllLabels(java.util.Arrays.asList(\"dev\", \"us-south\"))\n", " .build();\n", "\n", "SecretsPager pager = new SecretsPager(secretsManagerService, listSecretsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " limit: 10,\n", " sort: 'created_at',\n", " search: 'example',\n", " groups: ['default', 'cac40995-c37a-4dcb-9506-472869077634'],\n", " secretTypes: ['arbitrary', 'kv'],\n", " matchAllLabels: ['dev', 'us-south'],\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new SecretsManagerV2.SecretsPager(secretsManagerService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "all_results = []\n", "pager = SecretsPager(\n", " client=secrets_manager_service,\n", " limit=10,\n", " sort='created_at',\n", " search='example',\n", " groups=['default', 'cac40995-c37a-4dcb-9506-472869077634'],\n", " secret_types=['arbitrary', 'kv'],\n", " match_all_labels=['dev', 'us-south'],\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listSecretsOptions := &secretsmanagerv2.ListSecretsOptions{\n", " Limit: core.Int64Ptr(int64(10)),\n", " Sort: core.StringPtr(\"created_at\"),\n", " Search: core.StringPtr(\"example\"),\n", " Groups: []string{\"default\", \"cac40995-c37a-4dcb-9506-472869077634\"},\n", " SecretTypes: []string{\"arbitrary\", \"kv\"},\n", " MatchAllLabels: []string{\"dev\", \"us-south\"},\n", "}\n", "\n", "pager, err := secretsManagerService.NewSecretsPager(listSecretsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []secretsmanagerv2.SecretMetadataIntf\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{id}": { "parameters": [ { "$ref": "#/components/parameters/SecretId" } ], "get": { "summary": "Get a secret", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret", "description": "View the details of a secret", "targetResourceType": "secret", "action": "secrets-manager.secret.read" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret.read" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret.read" } ] }, "tags": [ "Secrets" ], "description": "Get a secret and its details by specifying the ID of the secret.\n\nA successful request returns the secret data that is associated with your secret, along with other metadata. To\nview only the details of a specified secret without retrieving its value, use the Get secret metadata operation.", "x-cli-description": "Get a secret and its details. This command returns the secret data that is associated with your secret.", "operationId": "get_secret", "responses": { "200": { "description": "The secret was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Secret" }, "examples": { "ArbitrarySecret": { "$ref": "#/components/examples/ArbitrarySecret" }, "IAMCredentialsSecret": { "$ref": "#/components/examples/IAMCredentialsSecret" }, "ImportedCertificate": { "$ref": "#/components/examples/ImportedCertificate" }, "KVSecret": { "$ref": "#/components/examples/KVSecret" }, "PrivateCertificate": { "$ref": "#/components/examples/PrivateCertificate" }, "PublicCertificate": { "$ref": "#/components/examples/PublicCertificate" }, "ServiceCredentialsSecret": { "$ref": "#/components/examples/ServiceCredentialsSecret" }, "UsernamePasswordSecret": { "$ref": "#/components/examples/UsernamePasswordSecret" }, "CustomCredentialsSecret": { "$ref": "#/components/examples/CustomCredentialsSecret" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "GetSecretOptions getSecretOptions = new GetSecretOptions.Builder()\n", " .id(secretIdForGetSecretLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.getSecret(getSecretOptions).execute();\n", "Secret secret = response.getResult();\n", "\n", "System.out.println(secret);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: secretIdForGetSecretLink,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.getSecret(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.get_secret(\n", " id=secret_id_for_get_secret_link,\n", ")\n", "secret = response.get_result()\n", "\n", "print(json.dumps(secret, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getSecretOptions := secretsManagerService.NewGetSecretOptions(\n", " secretIdForGetSecretLink,\n", ")\n", "\n", "secret, response, err := secretsManagerService.GetSecret(getSecretOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secret, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "summary": "Delete a secret", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret", "description": "Delete a secret", "targetResourceType": "secret", "action": "secrets-manager.secret.delete" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret.delete" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret.delete" } ] }, "tags": [ "Secrets" ], "description": "Delete a secret by specifying the ID of the secret.", "x-cli-description": "Delete a secret.", "operationId": "delete_secret", "parameters": [ { "name": "force_delete", "in": "query", "description": "Set to `true` to force delete the secret. Available only for custom credentials secret type.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "204": { "description": "The secret was successfully deleted." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "DeleteSecretOptions deleteSecretOptions = new DeleteSecretOptions.Builder()\n", " .id(secretIdForGetSecretLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.deleteSecret(deleteSecretOptions).execute();" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: secretIdForGetSecretLink,\n", "};\n", "\n", "try {\n", " await secretsManagerService.deleteSecret(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.delete_secret(\n", " id=secret_id_for_get_secret_link,\n", ")" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteSecretOptions := secretsManagerService.NewDeleteSecretOptions(\n", " secretIdForGetSecretLink,\n", ")\n", "\n", "response, err := secretsManagerService.DeleteSecret(deleteSecretOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteSecret(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } } }, "/api/v2/secrets/{id}/metadata": { "parameters": [ { "$ref": "#/components/parameters/SecretId" } ], "get": { "summary": "Get the metadata of a secret", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-metadata", "description": "View the details of a secret metadata", "targetResourceType": "secret", "action": "secrets-manager.secret-metadata.read" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-metadata.read" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-metadata.read" } ] }, "tags": [ "Secrets" ], "description": "Get the metadata of a secret by specifying the ID of the secret.", "x-cli-description": "Get the metadata of a secret.", "operationId": "get_secret_metadata", "responses": { "200": { "description": "The secret metadata was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretMetadata" }, "examples": { "ArbitrarySecretMetadata": { "$ref": "#/components/examples/ArbitrarySecretMetadata" }, "IAMCredentialsSecretMetadata": { "$ref": "#/components/examples/IAMCredentialsSecretMetadata" }, "ImportedCertificateMetadata": { "$ref": "#/components/examples/ImportedCertificateMetadata" }, "KVSecretMetadata": { "$ref": "#/components/examples/KVSecretMetadata" }, "PrivateCertificateMetadata": { "$ref": "#/components/examples/PrivateCertificateMetadata" }, "PublicCertificateMetadata": { "$ref": "#/components/examples/PublicCertificateMetadata" }, "ServiceCredentialsSecretMetadata": { "$ref": "#/components/examples/ServiceCredentialsSecretMetadata" }, "UsernamePasswordMetadata": { "$ref": "#/components/examples/UsernamePasswordMetadata" }, "CustomCredentialsSecretMetadata": { "$ref": "#/components/examples/CustomCredentialsSecretMetadata" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/metadata\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "GetSecretMetadataOptions getSecretMetadataOptions = new GetSecretMetadataOptions.Builder()\n", " .id(secretIdForGetSecretLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.getSecretMetadata(getSecretMetadataOptions).execute();\n", "SecretMetadata secretMetadata = response.getResult();\n", "\n", "System.out.println(secretMetadata);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: secretIdForGetSecretLink,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.getSecretMetadata(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.get_secret_metadata(\n", " id=secret_id_for_get_secret_link,\n", ")\n", "secret_metadata = response.get_result()\n", "\n", "print(json.dumps(secret_metadata, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getSecretMetadataOptions := secretsManagerService.NewGetSecretMetadataOptions(\n", " secretIdForGetSecretLink,\n", ")\n", "\n", "secretMetadata, response, err := secretsManagerService.GetSecretMetadata(getSecretMetadataOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretMetadata, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "patch": { "summary": "Update the metadata of a secret", "x-codegen-request-body-name": "SecretMetadataPatch", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-metadata", "description": "Update the metadata of a secret", "targetResourceType": "secret", "action": "secrets-manager.secret-metadata.update" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-metadata.update" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-metadata.update" } ] }, "tags": [ "Secrets" ], "description": "Update the metadata of a secret, such as its name or description.", "x-cli-description": "Update the metadata of a secret, such as its name or description.", "operationId": "update_secret_metadata", "x-sdk-depends-on-operations": [ "list_secrets" ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/SecretMetadataPatch" }, "examples": { "ArbitrarySecretMetadataPatch": { "$ref": "#/components/examples/ArbitrarySecretMetadataPatch" }, "IAMCredentialsSecretMetadataPatch": { "$ref": "#/components/examples/IAMCredentialsSecretMetadataPatch" }, "ImportedCertificateMetadataPatch": { "$ref": "#/components/examples/ImportedCertificateMetadataPatch" }, "ImportedCertificateManagedCsrMetadataPatch": { "$ref": "#/components/examples/ImportedCertificateManagedCsrMetadataPatch" }, "KVSecretMetadataPatch": { "$ref": "#/components/examples/KVSecretMetadataPatch" }, "PrivateCertificateMetadataPatch": { "$ref": "#/components/examples/PrivateCertificateMetadataPatch" }, "PublicCertificateMetadataPatch": { "$ref": "#/components/examples/PublicCertificateMetadataPatch" }, "ServiceCredentialsSecretMetadataPatch": { "$ref": "#/components/examples/ServiceCredentialsSecretMetadataPatch" }, "UsernamePasswordSecretMetadataPatch": { "$ref": "#/components/examples/UsernamePasswordSecretMetadataPatch" }, "CustomCredentialsSecretMetadataPatch": { "$ref": "#/components/examples/CustomCredentialsSecretMetadataPatch" } } } } }, "responses": { "200": { "description": "The secret's metadata was successfully updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretMetadata" }, "examples": { "ArbitrarySecretMetadata": { "$ref": "#/components/examples/ArbitrarySecretMetadata" }, "IAMCredentialsSecretMetadata": { "$ref": "#/components/examples/IAMCredentialsSecretMetadata" }, "ImportedCertificateMetadata": { "$ref": "#/components/examples/ImportedCertificateMetadata" }, "ImportedCertificateManagedCsrMetadata": { "$ref": "#/components/examples/ImportedCertificateManagedCsrMetadata" }, "KVSecretMetadata": { "$ref": "#/components/examples/KVSecretMetadata" }, "PrivateCertificateMetadata": { "$ref": "#/components/examples/PrivateCertificateMetadata" }, "PublicCertificateMetadata": { "$ref": "#/components/examples/PublicCertificateMetadata" }, "ServiceCredentialsSecretMetadata": { "$ref": "#/components/examples/ServiceCredentialsSecretMetadata" }, "UsernamePasswordSecretMetadata": { "$ref": "#/components/examples/UsernamePasswordSecretMetadata" }, "CustomCredentialsSecretMetadata": { "$ref": "#/components/examples/CustomCredentialsSecretMetadata" } } } }, "links": { "SecretName": { "$ref": "#/components/links/SecretNameForGetSecretByName" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/merge-patch+json\" \\\n", " --data '{\"custom_metadata\":{\"metadata_custom_key\":\"metadata_custom_value\"},\"description\":\"updated Arbitrary Secret description\",\"labels\":[\"dev\",\"us-south\"],\"name\":\"updated-arbitrary-secret-name-example\"}' \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/metadata\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ArbitrarySecretMetadataPatch secretMetadataPatchModel = new ArbitrarySecretMetadataPatch.Builder()\n", " .name(\"updated-arbitrary-secret-name-example\")\n", " .description(\"updated Arbitrary Secret description\")\n", " .labels(java.util.Arrays.asList(\"dev\", \"us-south\"))\n", " .build();\n", "Map secretMetadataPatchModelAsPatch = secretMetadataPatchModel.asPatch();\n", "UpdateSecretMetadataOptions updateSecretMetadataOptions = new UpdateSecretMetadataOptions.Builder()\n", " .id(secretIdForGetSecretLink)\n", " .secretMetadataPatch(secretMetadataPatchModelAsPatch)\n", " .build();\n", "\n", "Response response = secretsManagerService.updateSecretMetadata(updateSecretMetadataOptions).execute();\n", "SecretMetadata secretMetadata = response.getResult();\n", "\n", "System.out.println(secretMetadata);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// ArbitrarySecretMetadataPatch\n", "const secretMetadataPatchModel = {\n", " name: 'updated-arbitrary-secret-name-example',\n", " description: 'updated Arbitrary Secret description',\n", " labels: ['dev', 'us-south'],\n", " custom_metadata: { metadata_custom_key: 'metadata_custom_value' },\n", "};\n", "\n", "const params = {\n", " id: secretIdForGetSecretLink,\n", " secretMetadataPatch: secretMetadataPatchModel,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.updateSecretMetadata(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secret_metadata_patch_model = {\n", " 'name': 'updated-arbitrary-secret-name-example',\n", " 'description': 'updated Arbitrary Secret description',\n", " 'labels': ['dev', 'us-south'],\n", " 'custom_metadata': {'metadata_custom_key': 'metadata_custom_value'},\n", "}\n", "\n", "response = secrets_manager_service.update_secret_metadata(\n", " id=secret_id_for_get_secret_link,\n", " secret_metadata_patch=secret_metadata_patch_model,\n", ")\n", "secret_metadata = response.get_result()\n", "\n", "print(json.dumps(secret_metadata, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secretMetadataPatchModel := &secretsmanagerv2.ArbitrarySecretMetadataPatch{\n", " Name: core.StringPtr(\"updated-arbitrary-secret-name-example\"),\n", " Description: core.StringPtr(\"updated Arbitrary Secret description\"),\n", " Labels: []string{\"dev\", \"us-south\"},\n", "}\n", "secretMetadataPatchModelAsPatch, asPatchErr := secretMetadataPatchModel.AsPatch()\n", "Expect(asPatchErr).To(BeNil())\n", "\n", "updateSecretMetadataOptions := secretsManagerService.NewUpdateSecretMetadataOptions(\n", " secretIdForGetSecretLink,\n", " secretMetadataPatchModelAsPatch,\n", ")\n", "\n", "secretMetadata, response, err := secretsManagerService.UpdateSecretMetadata(updateSecretMetadataOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretMetadata, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{id}/actions": { "parameters": [ { "$ref": "#/components/parameters/SecretId" } ], "post": { "summary": "Create a secret action", "x-codegen-request-body-name": "SecretActionPrototype", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-action", "description": "Create a secret action", "targetResourceType": "secret", "action": "secrets-manager.secret-action.create" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-action.create" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-action.create" } ] }, "tags": [ "Secrets" ], "description": "Create a secret action. This operation supports the following actions:", "x-cli-description": "Create an action on a secret.", "operationId": "create_secret_action", "x-sdk-operations": { "request-examples": { "cli": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ibmcloud secrets-manager secret-action-create --id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 --secret-action-type=public_cert_action_validate_dns_challenge", "\n\n", "ibmcloud secrets-manager secret-action-create \\\n", " --id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \\\n", " --secret-action-prototype='{\"action_type\": \"public_cert_action_validate_dns_challenge\"}'\n" ] } ] } ], "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"action_type\": \"private_cert_action_revoke_certificate\" }' \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/actions\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "PrivateCertificateActionRevokePrototype secretActionPrototypeModel = new PrivateCertificateActionRevokePrototype.Builder()\n", " .actionType(\"private_cert_action_revoke_certificate\")\n", " .build();\n", "CreateSecretActionOptions createSecretActionOptions = new CreateSecretActionOptions.Builder()\n", " .id(secretIdForGetSecretLink)\n", " .secretActionPrototype(secretActionPrototypeModel)\n", " .build();\n", "\n", "Response response = secretsManagerService.createSecretAction(createSecretActionOptions).execute();\n", "SecretAction secretAction = response.getResult();\n", "\n", "System.out.println(secretAction);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// PrivateCertificateActionRevokePrototype\n", "const secretActionPrototypeModel = {\n", " action_type: 'private_cert_action_revoke_certificate',\n", "};\n", "\n", "const params = {\n", " id: secretIdForGetSecretLink,\n", " secretActionPrototype: secretActionPrototypeModel,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.createSecretAction(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secret_action_prototype_model = {\n", " 'action_type': 'private_cert_action_revoke_certificate',\n", "}\n", "\n", "response = secrets_manager_service.create_secret_action(\n", " id=secret_id_for_get_secret_link,\n", " secret_action_prototype=secret_action_prototype_model,\n", ")\n", "secret_action = response.get_result()\n", "\n", "print(json.dumps(secret_action, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secretActionPrototypeModel := &secretsmanagerv2.PrivateCertificateActionRevokePrototype{\n", " ActionType: core.StringPtr(\"private_cert_action_revoke_certificate\"),\n", "}\n", "\n", "createSecretActionOptions := secretsManagerService.NewCreateSecretActionOptions(\n", " secretIdForGetSecretLink,\n", " secretActionPrototypeModel,\n", ")\n", "\n", "secretAction, response, err := secretsManagerService.CreateSecretAction(createSecretActionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretAction, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretActionPrototype" }, "examples": { "PrivateCertificateActionRevokePrototype": { "$ref": "#/components/examples/PrivateCertificateActionRevokePrototype" }, "PublicCertificateActionValidateManualDNSPrototype": { "$ref": "#/components/examples/PublicCertificateActionValidateManualDNSPrototype" } } } } }, "responses": { "201": { "description": "The secret action was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretAction" }, "examples": { "PrivateCertificateActionRevoke": { "$ref": "#/components/examples/PrivateCertificateActionRevoke" }, "PublicCertificateActionValidateManualDNS": { "$ref": "#/components/examples/PublicCertificateActionValidateManualDNS" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } } } }, "/api/v2/secrets/{secret_id}/tasks": { "parameters": [ { "$ref": "#/components/parameters/SecretQualifiedId" } ], "get": { "summary": "List secret tasks", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-tasks", "description": "List secret tasks", "targetResourceType": "secret", "action": "secrets-manager.secret-tasks.list" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-tasks.list" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-tasks.list" } ] }, "tags": [ "Secret tasks" ], "description": "List secret tasks. \n\nSupported secret types: `custom_credentials`.", "x-cli-description": "List secret tasks. Supported secret types: custom_credentials.", "operationId": "list_secret_tasks", "responses": { "200": { "description": "The list of secret tasks was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretTaskCollection" }, "examples": { "SecretTaskCollection": { "$ref": "#/components/examples/SecretTaskCollection" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/tasks\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ListSecretTasksOptions listSecretTasksOptions = new ListSecretTasksOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.listSecretTasks(listSecretTasksOptions).execute();\n", "SecretTaskCollection secretTaskCollection = response.getResult();\n", "\n", "System.out.println(secretTaskCollection);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretId: secretIdForGetSecretLink,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.listSecretTasks(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.list_secret_tasks(\n", " secret_id=secret_id_for_get_secret_link,\n", ")\n", "secret_task_collection = response.get_result()\n", "\n", "print(json.dumps(secret_task_collection, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listSecretTasksOptions := secretsManagerService.NewListSecretTasksOptions(\n", " secretIdForGetSecretLink,\n", ")\n", "\n", "secretTaskCollection, response, err := secretsManagerService.ListSecretTasks(listSecretTasksOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretTaskCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{secret_id}/tasks/{id}": { "parameters": [ { "$ref": "#/components/parameters/SecretQualifiedId" }, { "$ref": "#/components/parameters/TaskId" } ], "get": { "summary": "Get a secret's task", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-task", "description": "View the details of a secret's task", "targetResourceType": "secret", "action": "secrets-manager.secret-task.read" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-task.read" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-task.read" } ] }, "tags": [ "Secret tasks" ], "description": "Get a task of a secret and its details by specifying the ID of the task.\n\nA successful request returns the task that is associated with your secret.\n\nSupported secret types: `custom_credentials`.", "x-cli-description": "Get a task of a secret and its details by specifying the ID of the task. A successful request returns the task that is associated with your secret. Supported secret types: custom_credentials.", "operationId": "get_secret_task", "responses": { "200": { "description": "The task was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretTask" }, "examples": { "SecretTask": { "$ref": "#/components/examples/SecretTask" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/tasks/secretIdForGetSecretLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "GetSecretTaskOptions getSecretTaskOptions = new GetSecretTaskOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretIdForGetSecretLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.getSecretTask(getSecretTaskOptions).execute();\n", "SecretTask secretTask = response.getResult();\n", "\n", "System.out.println(secretTask);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretIdForGetSecretLink,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.getSecretTask(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.get_secret_task(\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_id_for_get_secret_link,\n", ")\n", "secret_task = response.get_result()\n", "\n", "print(json.dumps(secret_task, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getSecretTaskOptions := secretsManagerService.NewGetSecretTaskOptions(\n", " secretIdForGetSecretLink,\n", " secretIdForGetSecretLink,\n", ")\n", "\n", "secretTask, response, err := secretsManagerService.GetSecretTask(getSecretTaskOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretTask, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "summary": "Update a secret's task", "x-codegen-request-body-name": "TaskPut", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-task", "description": "Update the state of a task", "targetResourceType": "secret", "action": "secrets-manager.secret-task.update" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-task.update" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-task.update" } ] }, "tags": [ "Secret tasks" ], "description": "A callback endpoint for updating a task with results.\n\nSupported secret types: `custom_credentials`.", "x-cli-description": "A callback endpoint for updating a task with results. Supported secret types: custom_credentials.", "operationId": "replace_secret_task", "x-cli-command": "secret-task-update", "x-sdk-depends-on-operations": [ "list_secret_tasks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretTaskPrototype" }, "examples": { "UpdateSecretTaskCredentialsCreated": { "$ref": "#/components/examples/UpdateSecretTaskCredentialsCreated" }, "UpdateSecretTaskCredentialsDeleted": { "$ref": "#/components/examples/UpdateSecretTaskCredentialsDeleted" }, "UpdateSecretTaskFailed": { "$ref": "#/components/examples/UpdateSecretTaskFailed" } } } } }, "responses": { "200": { "description": "The task was successfully updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretTask" }, "examples": { "SecretTask": { "$ref": "#/components/examples/SecretTask" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"status\": \"credentials_created\", \"credentials\": { \"id\": \"b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5\", \"payload\": { \"token\": \"xF9v7OztItL5DOnFgHfS9NCT1sLTUew8KYZcZfxI\" } } }' \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/tasks/secretIdForGetSecretLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "CustomCredentialsNewCredentials customCredentialsNewCredentialsModel = new CustomCredentialsNewCredentials.Builder()\n", " .id(\"b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5\")\n", " .payload(new java.util.HashMap())\n", " .build();\n", "SecretTaskPrototypeUpdateSecretTaskCredentialsCreated secretTaskPrototypeModel = new SecretTaskPrototypeUpdateSecretTaskCredentialsCreated.Builder()\n", " .status(\"credentials_created\")\n", " .credentials(customCredentialsNewCredentialsModel)\n", " .build();\n", "ReplaceSecretTaskOptions replaceSecretTaskOptions = new ReplaceSecretTaskOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretIdForGetSecretLink)\n", " .taskPut(secretTaskPrototypeModel)\n", " .build();\n", "\n", "Response response = secretsManagerService.replaceSecretTask(replaceSecretTaskOptions).execute();\n", "SecretTask secretTask = response.getResult();\n", "\n", "System.out.println(secretTask);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// CustomCredentialsNewCredentials\n", "const customCredentialsNewCredentialsModel = {\n", " id: 'b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5',\n", " payload: { token: 'xF9v7OztItL5DOnFgHfS9NCT1sLTUew8KYZcZfxI' },\n", "};\n", "\n", "// SecretTaskPrototypeUpdateSecretTaskCredentialsCreated\n", "const secretTaskPrototypeModel = {\n", " status: 'credentials_created',\n", " credentials: customCredentialsNewCredentialsModel,\n", "};\n", "\n", "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretIdForGetSecretLink,\n", " taskPut: secretTaskPrototypeModel,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.replaceSecretTask(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "custom_credentials_new_credentials_model = {\n", " 'id': 'b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5',\n", " 'payload': {'token': 'xF9v7OztItL5DOnFgHfS9NCT1sLTUew8KYZcZfxI'},\n", "}\n", "\n", "secret_task_prototype_model = {\n", " 'status': 'credentials_created',\n", " 'credentials': custom_credentials_new_credentials_model,\n", "}\n", "\n", "response = secrets_manager_service.replace_secret_task(\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_id_for_get_secret_link,\n", " task_put=secret_task_prototype_model,\n", ")\n", "secret_task = response.get_result()\n", "\n", "print(json.dumps(secret_task, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "customCredentialsNewCredentialsModel := &secretsmanagerv2.CustomCredentialsNewCredentials{\n", " ID: core.StringPtr(\"b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5\"),\n", " Payload: map[string]interface{}{\"anyKey\": \"anyValue\"},\n", "}\n", "\n", "secretTaskPrototypeModel := &secretsmanagerv2.SecretTaskPrototypeUpdateSecretTaskCredentialsCreated{\n", " Status: core.StringPtr(\"credentials_created\"),\n", " Credentials: customCredentialsNewCredentialsModel,\n", "}\n", "\n", "replaceSecretTaskOptions := secretsManagerService.NewReplaceSecretTaskOptions(\n", " secretIdForGetSecretLink,\n", " secretIdForGetSecretLink,\n", " secretTaskPrototypeModel,\n", ")\n", "\n", "secretTask, response, err := secretsManagerService.ReplaceSecretTask(replaceSecretTaskOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretTask, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "summary": "Delete a task", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret", "description": "Delete a task", "targetResourceType": "secret", "action": "secrets-manager.secret-task.delete" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-task.delete" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-task.delete" } ] }, "tags": [ "Secret tasks" ], "description": "Delete a task by specifying the ID of the secret.\n\nSupported secret types: `custom_credentials`.", "x-cli-description": "Delete a task by specifying the ID of the secret. Supported secret types: custom_credentials.", "operationId": "delete_secret_task", "responses": { "204": { "description": "The task was successfully deleted." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/tasks/secretIdForGetSecretLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "DeleteSecretTaskOptions deleteSecretTaskOptions = new DeleteSecretTaskOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretIdForGetSecretLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.deleteSecretTask(deleteSecretTaskOptions).execute();" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretIdForGetSecretLink,\n", "};\n", "\n", "try {\n", " await secretsManagerService.deleteSecretTask(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.delete_secret_task(\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_id_for_get_secret_link,\n", ")" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteSecretTaskOptions := secretsManagerService.NewDeleteSecretTaskOptions(\n", " secretIdForGetSecretLink,\n", " secretIdForGetSecretLink,\n", ")\n", "\n", "response, err := secretsManagerService.DeleteSecretTask(deleteSecretTaskOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteSecretTask(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } } }, "/api/v2/secret_groups/{secret_group_name}/secret_types/{secret_type}/secrets/{name}": { "parameters": [ { "$ref": "#/components/parameters/SecretType" }, { "$ref": "#/components/parameters/SecretName" }, { "$ref": "#/components/parameters/SecretGroupName" } ], "get": { "summary": "Get a secret by name", "x-cli-command": "secret-by-name", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret", "description": "View the details of a secret", "targetResourceType": "secret", "action": "secrets-manager.secret.read" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret.read" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret.read" } ] }, "tags": [ "Secrets" ], "description": "Get a secret and its details by specifying the Name and Type of the secret.\n\nA successful request returns the secret data that is associated with your secret, along with other metadata. To\nview only the details of a specified secret without retrieving its value, use the Get secret metadata operation.", "x-cli-description": "Get a secret and its details. This command returns the secret data that is associated with your secret.", "operationId": "get_secret_by_name_type", "responses": { "200": { "description": "The secret was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Secret" }, "examples": { "ArbitrarySecret": { "$ref": "#/components/examples/ArbitrarySecret" }, "IAMCredentialsSecret": { "$ref": "#/components/examples/IAMCredentialsSecret" }, "ImportedCertificate": { "$ref": "#/components/examples/ImportedCertificate" }, "KVSecret": { "$ref": "#/components/examples/KVSecret" }, "PrivateCertificate": { "$ref": "#/components/examples/PrivateCertificate" }, "PublicCertificate": { "$ref": "#/components/examples/PublicCertificate" }, "ServiceCredentialsSecret": { "$ref": "#/components/examples/ServiceCredentialsSecret" }, "UsernamePasswordSecret": { "$ref": "#/components/examples/UsernamePasswordSecret" }, "CustomCredentialsSecret": { "$ref": "#/components/examples/CustomCredentialsSecret" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "501": { "$ref": "#/components/responses/NotImplemented" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secret_groups/default/secret_types/testString/secrets/secretNameLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "GetSecretByNameTypeOptions getSecretByNameTypeOptions = new GetSecretByNameTypeOptions.Builder()\n", " .secretType(\"arbitrary\")\n", " .name(secretNameLink)\n", " .secretGroupName(\"default\")\n", " .build();\n", "\n", "Response response = secretsManagerService.getSecretByNameType(getSecretByNameTypeOptions).execute();\n", "Secret secret = response.getResult();\n", "\n", "System.out.println(secret);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretType: 'arbitrary',\n", " name: secretNameLink,\n", " secretGroupName: 'default',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.getSecretByNameType(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.get_secret_by_name_type(\n", " secret_type='arbitrary',\n", " name=secret_name_link,\n", " secret_group_name='default',\n", ")\n", "secret = response.get_result()\n", "\n", "print(json.dumps(secret, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getSecretByNameTypeOptions := secretsManagerService.NewGetSecretByNameTypeOptions(\n", " \"arbitrary\",\n", " secretNameLink,\n", " \"default\",\n", ")\n", "\n", "secret, response, err := secretsManagerService.GetSecretByNameType(getSecretByNameTypeOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secret, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{secret_id}/versions": { "parameters": [ { "$ref": "#/components/parameters/SecretQualifiedId" } ], "post": { "summary": "Create a new secret version", "x-codegen-request-body-name": "SecretVersionPrototype", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-version", "targetResourceType": "secret", "description": "Create a new secret version", "action": "secrets-manager.secret-version.create" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-version.create" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-version.create" } ] }, "tags": [ "Secret versions" ], "description": "Create a new secret version.", "x-cli-description": "Create a new secret version.", "operationId": "create_secret_version", "x-sdk-operations": { "request-examples": { "cli": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ibmcloud secrets-manager secret-version-create --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 --arbitrary-payload='updated secret credentials' --secret-version-custom-metadata='{\"anyKey\": \"anyValue\"}'", "\n\n", "ibmcloud secrets-manager secret-version-create \\\n", " --secret-id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \\\n", " --secret-version-prototype='{\"payload\": \"updated secret credentials\", \"custom_metadata\": {\"anyKey\": \"anyValue\"}, \"version_custom_metadata\": {\"anyKey\": \"anyValue\"}}'\n" ] } ] } ], "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"custom_metadata\": { \"metadata_custom_key\": \"metadata_custom_value\" }, \"payload\": \"updated secret credentials\", \"version_custom_metadata\": { \"custom_version_key\": \"custom_version_value\" } }' \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/versions\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ArbitrarySecretVersionPrototype secretVersionPrototypeModel = new ArbitrarySecretVersionPrototype.Builder()\n", " .payload(\"updated secret credentials\")\n", " .build();\n", "CreateSecretVersionOptions createSecretVersionOptions = new CreateSecretVersionOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .secretVersionPrototype(secretVersionPrototypeModel)\n", " .build();\n", "\n", "Response response = secretsManagerService.createSecretVersion(createSecretVersionOptions).execute();\n", "SecretVersion secretVersion = response.getResult();\n", "\n", "System.out.println(secretVersion);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// ArbitrarySecretVersionPrototype\n", "const secretVersionPrototypeModel = {\n", " payload: 'updated secret credentials',\n", " custom_metadata: { metadata_custom_key: 'metadata_custom_value' },\n", " version_custom_metadata: { custom_version_key: 'custom_version_value' },\n", "};\n", "\n", "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " secretVersionPrototype: secretVersionPrototypeModel,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.createSecretVersion(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secret_version_prototype_model = {\n", " 'payload': 'updated secret credentials',\n", " 'custom_metadata': {'metadata_custom_key': 'metadata_custom_value'},\n", " 'version_custom_metadata': {'custom_version_key': 'custom_version_value'},\n", "}\n", "\n", "response = secrets_manager_service.create_secret_version(\n", " secret_id=secret_id_for_get_secret_link,\n", " secret_version_prototype=secret_version_prototype_model,\n", ")\n", "secret_version = response.get_result()\n", "\n", "print(json.dumps(secret_version, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secretVersionPrototypeModel := &secretsmanagerv2.ArbitrarySecretVersionPrototype{\n", " Payload: core.StringPtr(\"updated secret credentials\"),\n", "}\n", "\n", "createSecretVersionOptions := secretsManagerService.NewCreateSecretVersionOptions(\n", " secretIdForGetSecretLink,\n", " secretVersionPrototypeModel,\n", ")\n", "\n", "secretVersion, response, err := secretsManagerService.CreateSecretVersion(createSecretVersionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretVersion, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretVersionPrototype" }, "examples": { "ArbitrarySecretVersionPrototype": { "$ref": "#/components/examples/ArbitrarySecretVersionPrototype" }, "IAMCredentialsSecretRestoreFromVersionPrototype": { "$ref": "#/components/examples/IAMCredentialsSecretRestoreFromVersionPrototype" }, "IAMCredentialsSecretVersionPrototype": { "$ref": "#/components/examples/IAMCredentialsSecretVersionPrototype" }, "ImportedCertificateVersionPrototype": { "$ref": "#/components/examples/ImportedCertificateVersionPrototype" }, "ImportedCertificateManagedCsrVersionPrototype": { "$ref": "#/components/examples/ImportedCertificateManagedCsrVersionPrototype" }, "KVSecretVersionPrototype": { "$ref": "#/components/examples/KVSecretVersionPrototype" }, "PrivateCertificateVersionPrototype": { "$ref": "#/components/examples/PrivateCertificateVersionPrototype" }, "PublicCertificateVersionPrototype": { "$ref": "#/components/examples/PublicCertificateVersionPrototype" }, "ServiceCredentialsSecretVersionPrototype": { "$ref": "#/components/examples/ServiceCredentialsSecretVersionPrototype" }, "UsernamePasswordSecretVersionPrototype": { "$ref": "#/components/examples/UsernamePasswordSecretVersionPrototype" }, "CustomCredentialsSecretVersionPrototype": { "$ref": "#/components/examples/CustomCredentialsSecretVersionPrototype" } } } } }, "responses": { "201": { "description": "A new secret version was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretVersion" }, "examples": { "ArbitrarySecretVersion": { "$ref": "#/components/examples/ArbitrarySecretVersion" }, "IAMCredentialsSecretVersion": { "$ref": "#/components/examples/IAMCredentialsSecretVersion" }, "ImportedCertificateVersion": { "$ref": "#/components/examples/ImportedCertificateVersion" }, "ImportedCertificateManagedCsrVersion": { "$ref": "#/components/examples/ImportedCertificateManagedCsrVersion" }, "KVSecretVersion": { "$ref": "#/components/examples/KVSecretVersion" }, "PrivateCertificateVersion": { "$ref": "#/components/examples/PrivateCertificateVersion" }, "PublicCertificateVersion": { "$ref": "#/components/examples/PublicCertificateVersion" }, "ServiceCredentialsSecretVersion": { "$ref": "#/components/examples/ServiceCredentialsSecretVersion" }, "UsernamePasswordSecretVersion": { "$ref": "#/components/examples/UsernamePasswordSecretVersion" }, "CustomCredentialsSecretVersion": { "$ref": "#/components/examples/CustomCredentialsSecretVersion" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } } }, "get": { "summary": "List versions of a secret", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-versions", "description": "List the versions of a secret", "targetResourceType": "secret", "action": "secrets-manager.secret-versions.list" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-versions.list" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-versions.list" } ] }, "tags": [ "Secret versions" ], "description": "List the versions of a secret.\n\nA successful request returns the list of versions of a secret, along with the metadata of each version.", "x-cli-description": "List the versions of a secret.", "x-cli-table-filter-jmespath": "versions[*]", "operationId": "list_secret_versions", "responses": { "200": { "description": "The list of secret versions was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretVersionMetadataCollection" }, "examples": { "SecretVersionMetadataCollection": { "$ref": "#/components/examples/SecretVersionMetadataCollection" } } } }, "links": { "SecretVersionIdForGetSecretVersion": { "$ref": "#/components/links/SecretVersionIdForGetSecretVersion" }, "SecretIdForCreateSecretVersion": { "$ref": "#/components/links/SecretIdForCreateSecretVersion" }, "SecretVersionIdForGetSecretVersionMetadata": { "$ref": "#/components/links/SecretVersionIdForGetSecretVersionMetadata" }, "SecretVersionIdForUpdateSecretVersionMetadata": { "$ref": "#/components/links/SecretVersionIdForUpdateSecretVersionMetadata" }, "SecretIdForCreateSecretVersionLocks": { "$ref": "#/components/links/SecretIdForCreateSecretVersionLocks" }, "SecretVersionIdForCreateSecretVersionLocks": { "$ref": "#/components/links/SecretVersionIdForCreateSecretVersionLocks" }, "SecretVersionIdForDeleteSecretVersionLocks": { "$ref": "#/components/links/SecretVersionIdForDeleteSecretVersionLocks" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/versions\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ListSecretVersionsOptions listSecretVersionsOptions = new ListSecretVersionsOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.listSecretVersions(listSecretVersionsOptions).execute();\n", "SecretVersionMetadataCollection secretVersionMetadataCollection = response.getResult();\n", "\n", "System.out.println(secretVersionMetadataCollection);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretId: secretIdForGetSecretLink,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.listSecretVersions(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.list_secret_versions(\n", " secret_id=secret_id_for_get_secret_link,\n", ")\n", "secret_version_metadata_collection = response.get_result()\n", "\n", "print(json.dumps(secret_version_metadata_collection, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listSecretVersionsOptions := secretsManagerService.NewListSecretVersionsOptions(\n", " secretIdForGetSecretLink,\n", ")\n", "\n", "secretVersionMetadataCollection, response, err := secretsManagerService.ListSecretVersions(listSecretVersionsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretVersionMetadataCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{secret_id}/versions/{id}": { "parameters": [ { "$ref": "#/components/parameters/SecretQualifiedId" }, { "$ref": "#/components/parameters/SecretVersionId" } ], "get": { "summary": "Get a version of a secret", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-version", "description": "Get a version of a secret", "targetResourceType": "secret", "action": "secrets-manager.secret-version.read" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-version.read" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-version.read" } ] }, "tags": [ "Secret versions" ], "description": "Get a version of a secret by specifying the ID of the version.\nYou can use the `current` or `previous` aliases to refer to the current or previous secret version.\n\nA successful request returns the secret data that is associated with the specified version of your secret, along\nwith other metadata.", "x-cli-description": "Get a version of a secret.", "operationId": "get_secret_version", "responses": { "200": { "description": "The secret version was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretVersion" }, "examples": { "ArbitrarySecretVersion": { "$ref": "#/components/examples/ArbitrarySecretVersion" }, "IAMCredentialsSecretVersion": { "$ref": "#/components/examples/IAMCredentialsSecretVersion" }, "ImportedCertificateVersion": { "$ref": "#/components/examples/ImportedCertificateVersion" }, "KVSecretVersion": { "$ref": "#/components/examples/KVSecretVersion" }, "PrivateCertificateVersion": { "$ref": "#/components/examples/PrivateCertificateVersion" }, "PublicCertificateVersion": { "$ref": "#/components/examples/PublicCertificateVersion" }, "ServiceCredentialsSecretVersion": { "$ref": "#/components/examples/ServiceCredentialsSecretVersion" }, "UsernamePasswordSecretVersion": { "$ref": "#/components/examples/UsernamePasswordSecretVersion" }, "CustomCredentialsSecretVersion": { "$ref": "#/components/examples/CustomCredentialsSecretVersion" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "410": { "$ref": "#/components/responses/Gone" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/versions/secretVersionIdForGetSecretVersionLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "GetSecretVersionOptions getSecretVersionOptions = new GetSecretVersionOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretVersionIdForGetSecretVersionLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.getSecretVersion(getSecretVersionOptions).execute();\n", "SecretVersion secretVersion = response.getResult();\n", "\n", "System.out.println(secretVersion);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretVersionIdForGetSecretVersionLink,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.getSecretVersion(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.get_secret_version(\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_version_id_for_get_secret_version_link,\n", ")\n", "secret_version = response.get_result()\n", "\n", "print(json.dumps(secret_version, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getSecretVersionOptions := secretsManagerService.NewGetSecretVersionOptions(\n", " secretIdForGetSecretLink,\n", " secretVersionIdForGetSecretVersionLink,\n", ")\n", "\n", "secretVersion, response, err := secretsManagerService.GetSecretVersion(getSecretVersionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretVersion, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{secret_id}/versions/{id}/secret_data": { "parameters": [ { "$ref": "#/components/parameters/SecretQualifiedId" }, { "$ref": "#/components/parameters/SecretVersionId" } ], "delete": { "summary": "Delete the data of a secret version", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-version-data", "description": "Delete the data of a secret version", "targetResourceType": "secret", "action": "secrets-manager.secret-version-data.delete" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-version-data.delete" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-version-data.delete" } ] }, "tags": [ "Secret versions" ], "description": "Delete the data of a secret version by specifying its version ID.\n\nThis operation is available for the following secret types:\n\n`iam_credentials`: current version only\n\n`custom_credentials`: both current and previous versions", "x-cli-description": "Deletes secret version data by version ID. Supports iam_credentials current version, custom_credentials current and previous versions.", "operationId": "delete_secret_version_data", "responses": { "204": { "description": "The secret version's data was successfully deleted." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/versions/secretVersionIdForGetSecretVersionLink/secret_data\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "DeleteSecretVersionDataOptions deleteSecretVersionDataOptions = new DeleteSecretVersionDataOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretVersionIdForGetSecretVersionLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.deleteSecretVersionData(deleteSecretVersionDataOptions).execute();" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretVersionIdForGetSecretVersionLink,\n", "};\n", "\n", "try {\n", " await secretsManagerService.deleteSecretVersionData(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.delete_secret_version_data(\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_version_id_for_get_secret_version_link,\n", ")" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteSecretVersionDataOptions := secretsManagerService.NewDeleteSecretVersionDataOptions(\n", " secretIdForGetSecretLink,\n", " secretVersionIdForGetSecretVersionLink,\n", ")\n", "\n", "response, err := secretsManagerService.DeleteSecretVersionData(deleteSecretVersionDataOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteSecretVersionData(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } } }, "/api/v2/secrets/{secret_id}/versions/{id}/metadata": { "parameters": [ { "$ref": "#/components/parameters/SecretQualifiedId" }, { "$ref": "#/components/parameters/SecretVersionId" } ], "get": { "summary": "Get the metadata of a secret version", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-version-metadata", "description": "Get the metadata of a secret version", "targetResourceType": "secret", "action": "secrets-manager.secret-version-metadata.read" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-version-metadata.read" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-version-metadata.read" } ] }, "tags": [ "Secret versions" ], "description": "Get the metadata of a secret version by specifying the ID of the version.\nYou can use the `current` or `previous` aliases to refer to the current or previous secret version.\n\nA successful request returns the metadata that is associated with the specified version of your secret.", "x-cli-description": "Get the metadata that is associated with the version of a secret.", "operationId": "get_secret_version_metadata", "responses": { "200": { "description": "The secret version metadata was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretVersionMetadata" }, "examples": { "ArbitrarySecretVersionMetadata": { "$ref": "#/components/examples/ArbitrarySecretVersionMetadata" }, "IAMCredentialsSecretVersionMetadata": { "$ref": "#/components/examples/IAMCredentialsSecretVersionMetadata" }, "ImportedCertificateVersionMetadata": { "$ref": "#/components/examples/ImportedCertificateVersionMetadata" }, "KVSecretVersionMetadata": { "$ref": "#/components/examples/KVSecretVersionMetadata" }, "PrivateCertificateVersionMetadata": { "$ref": "#/components/examples/PrivateCertificateVersionMetadata" }, "PublicCertificateVersionMetadata": { "$ref": "#/components/examples/PublicCertificateVersionMetadata" }, "ServiceCredentialsSecretVersionMetadata": { "$ref": "#/components/examples/ServiceCredentialsSecretVersionMetadata" }, "UsernamePasswordSecretVersionMetadata": { "$ref": "#/components/examples/UsernamePasswordSecretVersionMetadata" }, "CustomCredentialsSecretVersionMetadata": { "$ref": "#/components/examples/CustomCredentialsSecretVersionMetadata" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/versions/secretVersionIdForGetSecretVersionLink/metadata\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "GetSecretVersionMetadataOptions getSecretVersionMetadataOptions = new GetSecretVersionMetadataOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretVersionIdForGetSecretVersionLink)\n", " .build();\n", "\n", "Response response = secretsManagerService.getSecretVersionMetadata(getSecretVersionMetadataOptions).execute();\n", "SecretVersionMetadata secretVersionMetadata = response.getResult();\n", "\n", "System.out.println(secretVersionMetadata);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretVersionIdForGetSecretVersionLink,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.getSecretVersionMetadata(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.get_secret_version_metadata(\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_version_id_for_get_secret_version_link,\n", ")\n", "secret_version_metadata = response.get_result()\n", "\n", "print(json.dumps(secret_version_metadata, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getSecretVersionMetadataOptions := secretsManagerService.NewGetSecretVersionMetadataOptions(\n", " secretIdForGetSecretLink,\n", " secretVersionIdForGetSecretVersionLink,\n", ")\n", "\n", "secretVersionMetadata, response, err := secretsManagerService.GetSecretVersionMetadata(getSecretVersionMetadataOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretVersionMetadata, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "patch": { "summary": "Update the metadata of a secret version", "x-codegen-request-body-name": "SecretVersionMetadataPatch", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-version-metadata", "description": "Update the metadata of a secret version", "targetResourceType": "secret", "action": "secrets-manager.secret-version-metadata.update" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-version-metadata.update" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-version-metadata.update" } ] }, "tags": [ "Secret versions" ], "description": "Update the custom metadata of a secret version.", "x-cli-description": "Update the custom metadata of a secret version.", "operationId": "update_secret_version_metadata", "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/SecretVersionMetadataPatch" } } } }, "responses": { "200": { "description": "The secret version's metadata was successfully updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretVersionMetadata" }, "examples": { "ArbitrarySecretVersionMetadata": { "$ref": "#/components/examples/ArbitrarySecretVersionMetadata" }, "IAMCredentialsSecretVersionMetadata": { "$ref": "#/components/examples/IAMCredentialsSecretVersionMetadata" }, "ImportedCertificateVersionMetadata": { "$ref": "#/components/examples/ImportedCertificateVersionMetadata" }, "KVSecretVersionMetadata": { "$ref": "#/components/examples/KVSecretVersionMetadata" }, "PrivateCertificateVersionMetadata": { "$ref": "#/components/examples/PrivateCertificateVersionMetadata" }, "PublicCertificateVersionMetadata": { "$ref": "#/components/examples/PublicCertificateVersionMetadata" }, "ServiceCredentialsSecretVersionMetadata": { "$ref": "#/components/examples/ServiceCredentialsSecretVersionMetadata" }, "UsernamePasswordSecretVersionMetadata": { "$ref": "#/components/examples/UsernamePasswordSecretVersionMetadata" }, "CustomCredentialsSecretVersionMetadata": { "$ref": "#/components/examples/CustomCredentialsSecretVersionMetadata" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/merge-patch+json\" \\\n", " --data '' \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/versions/secretVersionIdForGetSecretVersionLink/metadata\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "SecretVersionMetadataPatch secretVersionMetadataPatchModel = new SecretVersionMetadataPatch.Builder()\n", " .build();\n", "Map secretVersionMetadataPatchModelAsPatch = secretVersionMetadataPatchModel.asPatch();\n", "UpdateSecretVersionMetadataOptions updateSecretVersionMetadataOptions = new UpdateSecretVersionMetadataOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretVersionIdForGetSecretVersionLink)\n", " .secretVersionMetadataPatch(secretVersionMetadataPatchModelAsPatch)\n", " .build();\n", "\n", "Response response = secretsManagerService.updateSecretVersionMetadata(updateSecretVersionMetadataOptions).execute();\n", "SecretVersionMetadata secretVersionMetadata = response.getResult();\n", "\n", "System.out.println(secretVersionMetadata);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretVersionIdForGetSecretVersionLink,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.updateSecretVersionMetadata(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secret_version_metadata_patch_model = {\n", "}\n", "\n", "response = secrets_manager_service.update_secret_version_metadata(\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_version_id_for_get_secret_version_link,\n", " secret_version_metadata_patch=secret_version_metadata_patch_model,\n", ")\n", "secret_version_metadata = response.get_result()\n", "\n", "print(json.dumps(secret_version_metadata, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secretVersionMetadataPatchModel := &secretsmanagerv2.SecretVersionMetadataPatch{\n", "}\n", "secretVersionMetadataPatchModelAsPatch, asPatchErr := secretVersionMetadataPatchModel.AsPatch()\n", "Expect(asPatchErr).To(BeNil())\n", "\n", "updateSecretVersionMetadataOptions := secretsManagerService.NewUpdateSecretVersionMetadataOptions(\n", " secretIdForGetSecretLink,\n", " secretVersionIdForGetSecretVersionLink,\n", " secretVersionMetadataPatchModelAsPatch,\n", ")\n", "\n", "secretVersionMetadata, response, err := secretsManagerService.UpdateSecretVersionMetadata(updateSecretVersionMetadataOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretVersionMetadata, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{secret_id}/versions/{id}/actions": { "parameters": [ { "$ref": "#/components/parameters/SecretQualifiedId" }, { "$ref": "#/components/parameters/SecretVersionId" } ], "post": { "summary": "Create a version action", "x-codegen-request-body-name": "SecretVersionActionPrototype", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-version-action", "description": "Create a secret version action", "targetResourceType": "secret", "action": "secrets-manager.secret-version-action.create" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-version-action.create" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-version-action.create" } ] }, "tags": [ "Secret versions" ], "description": "Create a secret version action. This operation supports the following actions:\n\n- `private_cert_action_revoke_certificate`: Revoke a version of a private certificate.", "x-cli-description": "Create an action on a secret version.", "operationId": "create_secret_version_action", "x-sdk-operations": { "request-examples": { "cli": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ibmcloud secrets-manager secret--version-action-create --secret-id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 --id=eb4cf24d-9cae-424b-945e-159788a5f535 --secret-version-action-type=private_cert_action_revoke_certificate", "\n\n", "ibmcloud secrets-manager secret-version-action-create \\\n", " --secret-id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \\\n", " --id=eb4cf24d-9cae-424b-945e-159788a5f535 \\\n", " --secret-version-action-prototype='{\"action_type\": \"private_cert_action_revoke_certificate\"}'\n" ] } ] } ], "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"action_type\": \"private_cert_action_revoke_certificate\" }' \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/versions/secretVersionIdForGetSecretVersionLink/actions\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "PrivateCertificateVersionActionRevokePrototype secretVersionActionPrototypeModel = new PrivateCertificateVersionActionRevokePrototype.Builder()\n", " .actionType(\"private_cert_action_revoke_certificate\")\n", " .build();\n", "CreateSecretVersionActionOptions createSecretVersionActionOptions = new CreateSecretVersionActionOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretVersionIdForGetSecretVersionLink)\n", " .secretVersionActionPrototype(secretVersionActionPrototypeModel)\n", " .build();\n", "\n", "Response response = secretsManagerService.createSecretVersionAction(createSecretVersionActionOptions).execute();\n", "VersionAction versionAction = response.getResult();\n", "\n", "System.out.println(versionAction);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// PrivateCertificateVersionActionRevokePrototype\n", "const secretVersionActionPrototypeModel = {\n", " action_type: 'private_cert_action_revoke_certificate',\n", "};\n", "\n", "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretVersionIdForGetSecretVersionLink,\n", " secretVersionActionPrototype: secretVersionActionPrototypeModel,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.createSecretVersionAction(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secret_version_action_prototype_model = {\n", " 'action_type': 'private_cert_action_revoke_certificate',\n", "}\n", "\n", "response = secrets_manager_service.create_secret_version_action(\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_version_id_for_get_secret_version_link,\n", " secret_version_action_prototype=secret_version_action_prototype_model,\n", ")\n", "version_action = response.get_result()\n", "\n", "print(json.dumps(version_action, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secretVersionActionPrototypeModel := &secretsmanagerv2.PrivateCertificateVersionActionRevokePrototype{\n", " ActionType: core.StringPtr(\"private_cert_action_revoke_certificate\"),\n", "}\n", "\n", "createSecretVersionActionOptions := secretsManagerService.NewCreateSecretVersionActionOptions(\n", " secretIdForGetSecretLink,\n", " secretVersionIdForGetSecretVersionLink,\n", " secretVersionActionPrototypeModel,\n", ")\n", "\n", "versionAction, response, err := secretsManagerService.CreateSecretVersionAction(createSecretVersionActionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(versionAction, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretVersionActionPrototype" }, "examples": { "PrivateCertificateVersionActionRevokePrototype": { "$ref": "#/components/examples/PrivateCertificateVersionActionRevokePrototype" } } } } }, "responses": { "201": { "description": "The version action was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionAction" }, "examples": { "PrivateCertificateVersionActionRevoke": { "$ref": "#/components/examples/PrivateCertificateVersionActionRevoke" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } } } }, "/api/v2/secrets_locks": { "get": { "summary": "List secrets and their locks", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secrets", "description": "List the secrets and their locks", "action": "secrets-manager.secrets-locks.list" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secrets-locks.list" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secrets-locks.list" } ] }, "tags": [ "Secret locks" ], "description": "List the secrets and their locks in your Secrets Manager instance.", "x-cli-description": "List the secrets and their locks in your Secrets Manager instance.", "x-cli-table-filter-jmespath": "secrets_locks[*]", "operationId": "list_secrets_locks", "parameters": [ { "$ref": "#/components/parameters/SecretCollectionOffsetParam" }, { "$ref": "#/components/parameters/SecretCollectionLimitParam" }, { "$ref": "#/components/parameters/LocksCollectionSearchParam" }, { "$ref": "#/components/parameters/SecretCollectionGroupsParam" } ], "responses": { "200": { "description": "The list of secrets and their locks was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretsLocksPaginatedCollection" }, "examples": { "SecretsLockCollection": { "$ref": "#/components/examples/SecretsLocksPaginatedCollection" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets_locks?search=example&groups=[ \\\"default\\\", \\\"cac40995-c37a-4dcb-9506-472869077634\\\" ]\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ListSecretsLocksOptions listSecretsLocksOptions = new ListSecretsLocksOptions.Builder()\n", " .limit(Long.valueOf(\"10\"))\n", " .search(\"example\")\n", " .groups(java.util.Arrays.asList(\"default\", \"cac40995-c37a-4dcb-9506-472869077634\"))\n", " .build();\n", "\n", "SecretsLocksPager pager = new SecretsLocksPager(secretsManagerService, listSecretsLocksOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " limit: 10,\n", " search: 'example',\n", " groups: ['default', 'cac40995-c37a-4dcb-9506-472869077634'],\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new SecretsManagerV2.SecretsLocksPager(secretsManagerService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "all_results = []\n", "pager = SecretsLocksPager(\n", " client=secrets_manager_service,\n", " limit=10,\n", " search='example',\n", " groups=['default', 'cac40995-c37a-4dcb-9506-472869077634'],\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listSecretsLocksOptions := &secretsmanagerv2.ListSecretsLocksOptions{\n", " Limit: core.Int64Ptr(int64(10)),\n", " Search: core.StringPtr(\"example\"),\n", " Groups: []string{\"default\", \"cac40995-c37a-4dcb-9506-472869077634\"},\n", "}\n", "\n", "pager, err := secretsManagerService.NewSecretsLocksPager(listSecretsLocksOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []secretsmanagerv2.SecretLocks\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{id}/locks": { "parameters": [ { "$ref": "#/components/parameters/SecretId" } ], "get": { "summary": "List secret locks", "x-activity-tracker": { "dataEvent": false, "targetTypeURI": "secrets-manager/secret-locks", "description": "List secret locks", "targetResourceType": "secret", "action": "secrets-manager.secret-locks.list" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-locks.list" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-locks.list" } ] }, "tags": [ "Secret locks" ], "description": "List the locks that are associated with a specified secret.", "x-cli-description": "List the locks that are associated with a secret.", "operationId": "list_secret_locks", "x-sdk-depends-on-operations": [ "create_secret_locks_bulk" ], "parameters": [ { "$ref": "#/components/parameters/LocksCollectionOffsetParam" }, { "$ref": "#/components/parameters/LocksCollectionLimitParam" }, { "$ref": "#/components/parameters/LocksCollectionSortParam" }, { "$ref": "#/components/parameters/LocksCollectionSearchParam" } ], "responses": { "200": { "description": "The locks were successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretLocksPaginatedCollection" }, "examples": { "SecretLockCollection": { "$ref": "#/components/examples/SecretLocksPaginatedCollection" } } } }, "links": { "LockNameForDeleteSecretLocks": { "$ref": "#/components/links/LockNameForDeleteSecretLocks" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/locks?sort=name&search=example\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ListSecretLocksOptions listSecretLocksOptions = new ListSecretLocksOptions.Builder()\n", " .id(secretIdForGetSecretLink)\n", " .limit(Long.valueOf(\"10\"))\n", " .sort(\"name\")\n", " .search(\"example\")\n", " .build();\n", "\n", "SecretLocksPager pager = new SecretLocksPager(secretsManagerService, listSecretLocksOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: secretIdForGetSecretLink,\n", " limit: 10,\n", " sort: 'name',\n", " search: 'example',\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new SecretsManagerV2.SecretLocksPager(secretsManagerService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "all_results = []\n", "pager = SecretLocksPager(\n", " client=secrets_manager_service,\n", " id=secret_id_for_get_secret_link,\n", " limit=10,\n", " sort='name',\n", " search='example',\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listSecretLocksOptions := &secretsmanagerv2.ListSecretLocksOptions{\n", " ID: &secretIdForGetSecretLink,\n", " Limit: core.Int64Ptr(int64(10)),\n", " Sort: core.StringPtr(\"name\"),\n", " Search: core.StringPtr(\"example\"),\n", "}\n", "\n", "pager, err := secretsManagerService.NewSecretLocksPager(listSecretLocksOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []secretsmanagerv2.SecretLock\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{id}/locks_bulk": { "parameters": [ { "$ref": "#/components/parameters/SecretId" } ], "post": { "parameters": [ { "$ref": "#/components/parameters/SecretLocksMode" } ], "summary": "Create secret locks", "x-codegen-request-body-name": "SecretLocksPrototype", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-locks", "targetResourceType": "secret", "description": "Create secret locks", "action": "secrets-manager.secret-locks.create" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-locks.create" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-locks.create" } ] }, "tags": [ "Secret locks" ], "description": "Create a lock on the current version of a secret.\n\nA lock can be used to prevent a secret from being deleted or modified while it's in use by your applications. A\nsuccessful request attaches a new lock to your secret, or replaces a lock of the same name if it already exists.\nAdditionally, you can use this operation to clear any matching locks on a secret by using one of the following\noptional lock modes:\n\n- `remove_previous`: Removes any other locks with matching names if they are found in the previous version of the secret.\\n\n- `remove_previous_and_delete`: Carries out the same function as `remove_previous`, but also permanently deletes the data of the previous secret version if\nit doesn't have any locks.", "x-cli-description": "Create secret locks.", "operationId": "create_secret_locks_bulk", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretLockCollectionPrototype" }, "examples": { "SecretLockCollectionPrototype": { "$ref": "#/components/examples/SecretLockCollectionPrototype" } } } } }, "responses": { "201": { "description": "Secret locks were successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretLocks" }, "examples": { "SecretLocks": { "$ref": "#/components/examples/SecretLocks" } } } }, "links": { "LockNameForListSecretLocks": { "$ref": "#/components/links/LockNameForListSecretLocks" }, "SecretIdForListSecretLocks": { "$ref": "#/components/links/SecretIdForListSecretLocks" }, "SecretIdForListSecretVersionLocks": { "$ref": "#/components/links/SecretIdForListSecretVersionLocks" }, "SecretVersionIdForListSecretVersionLocks": { "$ref": "#/components/links/SecretVersionIdForListSecretVersionLocks" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"locks\": [ { \"name\": \"lock-example-1\", \"description\": \"lock for consumer 1\", \"attributes\": { \"key\": \"value\" } }, { \"name\": \"lock-example-2\", \"description\": \"lock for consumer 2\", \"attributes\": { \"key\": \"value\" } } ] }' \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/locks_bulk\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "SecretLockPrototype secretLockPrototypeModel = new SecretLockPrototype.Builder()\n", " .name(\"lock-example-1\")\n", " .description(\"lock for consumer 1\")\n", " .build();\n", "CreateSecretLocksBulkOptions createSecretLocksBulkOptions = new CreateSecretLocksBulkOptions.Builder()\n", " .id(secretIdForGetSecretLink)\n", " .locks(java.util.Arrays.asList(secretLockPrototypeModel))\n", " .build();\n", "\n", "Response response = secretsManagerService.createSecretLocksBulk(createSecretLocksBulkOptions).execute();\n", "SecretLocks secretLocks = response.getResult();\n", "\n", "System.out.println(secretLocks);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// SecretLockPrototype\n", "const secretLockPrototypeModel = {\n", " name: 'lock-example-1',\n", " description: 'lock for consumer 1',\n", " attributes: { key: 'value' },\n", "};\n", "\n", "const params = {\n", " id: secretIdForGetSecretLink,\n", " locks: [secretLockPrototypeModel],\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.createSecretLocksBulk(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secret_lock_prototype_model = {\n", " 'name': 'lock-example-1',\n", " 'description': 'lock for consumer 1',\n", " 'attributes': {'key': 'value'},\n", "}\n", "\n", "response = secrets_manager_service.create_secret_locks_bulk(\n", " id=secret_id_for_get_secret_link,\n", " locks=[secret_lock_prototype_model],\n", ")\n", "secret_locks = response.get_result()\n", "\n", "print(json.dumps(secret_locks, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secretLockPrototypeModel := &secretsmanagerv2.SecretLockPrototype{\n", " Name: core.StringPtr(\"lock-example-1\"),\n", " Description: core.StringPtr(\"lock for consumer 1\"),\n", "}\n", "\n", "createSecretLocksBulkOptions := secretsManagerService.NewCreateSecretLocksBulkOptions(\n", " secretIdForGetSecretLink,\n", " []secretsmanagerv2.SecretLockPrototype{*secretLockPrototypeModel},\n", ")\n", "\n", "secretLocks, response, err := secretsManagerService.CreateSecretLocksBulk(createSecretLocksBulkOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretLocks, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "parameters": [ { "$ref": "#/components/parameters/SecretLockDeleteItems" } ], "summary": "Delete secret locks", "x-activity-tracker": { "dataEvent": false, "targetTypeURI": "secrets-manager/secret-locks", "description": "Delete secret locks", "targetResourceType": "secret", "action": "secrets-manager.secret-locks.delete" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-locks.delete" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-locks.delete" } ] }, "tags": [ "Secret locks" ], "description": "Delete all the locks or a subset of the locks that are associated with a version of a secret.\n\nTo delete only a subset of the locks, add a query param with a comma to separate the list of lock names:\n\nExample: `?name=lock-example-1,lock-example-2`.\n\n**Note:** A secret is considered unlocked and able to be deleted only after you remove all of its locks.\nTo determine whether a secret contains locks, check the `locks_total` field that is returned as\npart of the metadata of your secret.", "x-cli-description": "Delete locks that are associated with the current secret version. Removing all locks will unlock the secret so that it can be rotated or deleted.", "operationId": "delete_secret_locks_bulk", "responses": { "200": { "description": "The locks were deleted successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretLocks" }, "examples": { "SecretLocks": { "$ref": "#/components/examples/SecretLocks" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/locks_bulk?name=[ \\\"lock-example-1\\\" ]\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "DeleteSecretLocksBulkOptions deleteSecretLocksBulkOptions = new DeleteSecretLocksBulkOptions.Builder()\n", " .id(secretIdForGetSecretLink)\n", " .name(java.util.Arrays.asList(\"lock-example-1\"))\n", " .build();\n", "\n", "Response response = secretsManagerService.deleteSecretLocksBulk(deleteSecretLocksBulkOptions).execute();\n", "SecretLocks secretLocks = response.getResult();\n", "\n", "System.out.println(secretLocks);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " id: secretIdForGetSecretLink,\n", " name: ['lock-example-1'],\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.deleteSecretLocksBulk(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.delete_secret_locks_bulk(\n", " id=secret_id_for_get_secret_link,\n", " name=['lock-example-1'],\n", ")\n", "secret_locks = response.get_result()\n", "\n", "print(json.dumps(secret_locks, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteSecretLocksBulkOptions := secretsManagerService.NewDeleteSecretLocksBulkOptions(\n", " secretIdForGetSecretLink,\n", ")\n", "deleteSecretLocksBulkOptions.SetName([]string{\"lock-example-1\"})\n", "\n", "secretLocks, response, err := secretsManagerService.DeleteSecretLocksBulk(deleteSecretLocksBulkOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretLocks, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{secret_id}/versions/{id}/locks": { "parameters": [ { "$ref": "#/components/parameters/SecretQualifiedId" }, { "$ref": "#/components/parameters/SecretVersionId" } ], "get": { "summary": "List secret version locks", "x-activity-tracker": { "dataEvent": false, "targetTypeURI": "secrets-manager/secret-version-locks", "description": "List secret version locks", "targetResourceType": "secret", "action": "secrets-manager.secret-version-locks.list" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-version-locks.list" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-versions-locks.list" } ] }, "tags": [ "Secret locks" ], "description": "List the locks that are associated with a specified secret version.", "x-cli-description": "List the locks that are associated with a secret version.", "operationId": "list_secret_version_locks", "x-sdk-depends-on-operations": [ "create_secret_version_locks_bulk" ], "parameters": [ { "$ref": "#/components/parameters/LocksCollectionOffsetParam" }, { "$ref": "#/components/parameters/LocksCollectionLimitParam" }, { "$ref": "#/components/parameters/LocksCollectionSortParam" }, { "$ref": "#/components/parameters/LocksCollectionSearchParam" } ], "responses": { "200": { "description": "Locks were successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretVersionLocksPaginatedCollection" }, "examples": { "SecretVersionLockCollection": { "$ref": "#/components/examples/SecretVersionLocksPaginatedCollection" } } } }, "links": { "LockNameForDeleteSecretVersionLocks": { "$ref": "#/components/links/LockNameForDeleteSecretVersionLocks" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/versions/secretVersionIdForGetSecretVersionLink/locks?sort=name&search=example\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ListSecretVersionLocksOptions listSecretVersionLocksOptions = new ListSecretVersionLocksOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretVersionIdForGetSecretVersionLink)\n", " .limit(Long.valueOf(\"10\"))\n", " .sort(\"name\")\n", " .search(\"example\")\n", " .build();\n", "\n", "SecretVersionLocksPager pager = new SecretVersionLocksPager(secretsManagerService, listSecretVersionLocksOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretVersionIdForGetSecretVersionLink,\n", " limit: 10,\n", " sort: 'name',\n", " search: 'example',\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new SecretsManagerV2.SecretVersionLocksPager(secretsManagerService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "all_results = []\n", "pager = SecretVersionLocksPager(\n", " client=secrets_manager_service,\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_version_id_for_get_secret_version_link,\n", " limit=10,\n", " sort='name',\n", " search='example',\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listSecretVersionLocksOptions := &secretsmanagerv2.ListSecretVersionLocksOptions{\n", " SecretID: &secretIdForGetSecretLink,\n", " ID: &secretVersionIdForGetSecretVersionLink,\n", " Limit: core.Int64Ptr(int64(10)),\n", " Sort: core.StringPtr(\"name\"),\n", " Search: core.StringPtr(\"example\"),\n", "}\n", "\n", "pager, err := secretsManagerService.NewSecretVersionLocksPager(listSecretVersionLocksOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []secretsmanagerv2.SecretLock\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/secrets/{secret_id}/versions/{id}/locks_bulk": { "parameters": [ { "$ref": "#/components/parameters/SecretQualifiedId" }, { "$ref": "#/components/parameters/SecretVersionId" } ], "post": { "parameters": [ { "$ref": "#/components/parameters/SecretLocksMode" } ], "summary": "Create secret version locks", "x-codegen-request-body-name": "SecretLocksPrototype", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/secret-version-locks", "targetResourceType": "secret", "description": "Create secret version locks", "action": "secrets-manager.secret-version-locks.create" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-version-locks.create" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-version-locks.create" } ] }, "tags": [ "Secret locks" ], "description": "Create a lock on the specified version of a secret.\n\nA lock can be used to prevent a secret from being deleted or modified while it's in use by your applications. A\nsuccessful request attaches a new lock to your secret, or replaces a lock of the same name if it already exists.\nAdditionally, you can use this operation to clear any matching locks on a secret by using one of the following\noptional lock modes:\n\n- `remove_previous`: Removes any other locks with matching names if they are found in the previous version of the secret.\n- `remove_previous_and_delete`: Carries out the same function as `remove_previous`, but also permanently deletes the data of the previous secret version if\nit doesn't have any locks.", "x-cli-description": "Create locks on a secret version.", "operationId": "create_secret_version_locks_bulk", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretLockCollectionPrototype" }, "examples": { "SecretLocksPrototype": { "$ref": "#/components/examples/SecretLockCollectionPrototype" } } } } }, "responses": { "201": { "description": "Secret locks were successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretLocks" }, "examples": { "SecretLocks": { "$ref": "#/components/examples/SecretLocks" } } } }, "links": { "LockNameForListSecretVersionLocks": { "$ref": "#/components/links/LockNameForListSecretVersionLocks" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"locks\": [ { \"name\": \"lock-example-1\", \"description\": \"lock for consumer 1\", \"attributes\": { \"key\": \"value\" } }, { \"name\": \"lock-example-2\", \"description\": \"lock for consumer 2\", \"attributes\": { \"key\": \"value\" } } ] }' \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/versions/secretVersionIdForGetSecretVersionLink/locks_bulk\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "SecretLockPrototype secretLockPrototypeModel = new SecretLockPrototype.Builder()\n", " .name(\"lock-example-1\")\n", " .description(\"lock for consumer 1\")\n", " .build();\n", "CreateSecretVersionLocksBulkOptions createSecretVersionLocksBulkOptions = new CreateSecretVersionLocksBulkOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretVersionIdForGetSecretVersionLink)\n", " .locks(java.util.Arrays.asList(secretLockPrototypeModel))\n", " .build();\n", "\n", "Response response = secretsManagerService.createSecretVersionLocksBulk(createSecretVersionLocksBulkOptions).execute();\n", "SecretLocks secretLocks = response.getResult();\n", "\n", "System.out.println(secretLocks);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// SecretLockPrototype\n", "const secretLockPrototypeModel = {\n", " name: 'lock-example-1',\n", " description: 'lock for consumer 1',\n", " attributes: { key: 'value' },\n", "};\n", "\n", "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretVersionIdForGetSecretVersionLink,\n", " locks: [secretLockPrototypeModel],\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.createSecretVersionLocksBulk(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secret_lock_prototype_model = {\n", " 'name': 'lock-example-1',\n", " 'description': 'lock for consumer 1',\n", " 'attributes': {'key': 'value'},\n", "}\n", "\n", "response = secrets_manager_service.create_secret_version_locks_bulk(\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_version_id_for_get_secret_version_link,\n", " locks=[secret_lock_prototype_model],\n", ")\n", "secret_locks = response.get_result()\n", "\n", "print(json.dumps(secret_locks, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "secretLockPrototypeModel := &secretsmanagerv2.SecretLockPrototype{\n", " Name: core.StringPtr(\"lock-example-1\"),\n", " Description: core.StringPtr(\"lock for consumer 1\"),\n", "}\n", "\n", "createSecretVersionLocksBulkOptions := secretsManagerService.NewCreateSecretVersionLocksBulkOptions(\n", " secretIdForGetSecretLink,\n", " secretVersionIdForGetSecretVersionLink,\n", " []secretsmanagerv2.SecretLockPrototype{*secretLockPrototypeModel},\n", ")\n", "\n", "secretLocks, response, err := secretsManagerService.CreateSecretVersionLocksBulk(createSecretVersionLocksBulkOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretLocks, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "parameters": [ { "$ref": "#/components/parameters/SecretLockDeleteItems" } ], "summary": "Delete locks on a secret version", "x-activity-tracker": { "dataEvent": false, "targetTypeURI": "secrets-manager/secret-version-locks", "description": "Delete locks on a secret version", "targetResourceType": "secret", "action": "secrets-manager.secret-version-locks.delete" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.secret-version-locks.delete" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.secret-version-locks.delete" } ] }, "tags": [ "Secret locks" ], "description": "Delete all the locks or a subset of the locks that are associated with the specified version of a secret.\n\nTo delete only a subset of the locks, add a query param with a comma to separate the list of lock names:\n\nExample: `?name=lock-example-1,lock-example-2`.\n\n**Note:** A secret is considered unlocked and able to be deleted only after all of its locks are\nremoved. To determine whether a secret contains locks, check the `locks_total` field that is returned as\npart of the metadata of your secret.", "x-cli-description": "Delete locks that are associated with the specified secret version.", "operationId": "delete_secret_version_locks_bulk", "responses": { "200": { "description": "The locks were deleted successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretLocks" }, "examples": { "SecretLocks": { "$ref": "#/components/examples/SecretLocks" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/secrets/secretIdForGetSecretLink/versions/secretVersionIdForGetSecretVersionLink/locks_bulk?name=[ \\\"lock-example-1\\\" ]\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "DeleteSecretVersionLocksBulkOptions deleteSecretVersionLocksBulkOptions = new DeleteSecretVersionLocksBulkOptions.Builder()\n", " .secretId(secretIdForGetSecretLink)\n", " .id(secretVersionIdForGetSecretVersionLink)\n", " .name(java.util.Arrays.asList(\"lock-example-1\"))\n", " .build();\n", "\n", "Response response = secretsManagerService.deleteSecretVersionLocksBulk(deleteSecretVersionLocksBulkOptions).execute();\n", "SecretLocks secretLocks = response.getResult();\n", "\n", "System.out.println(secretLocks);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " secretId: secretIdForGetSecretLink,\n", " id: secretVersionIdForGetSecretVersionLink,\n", " name: ['lock-example-1'],\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.deleteSecretVersionLocksBulk(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.delete_secret_version_locks_bulk(\n", " secret_id=secret_id_for_get_secret_link,\n", " id=secret_version_id_for_get_secret_version_link,\n", " name=['lock-example-1'],\n", ")\n", "secret_locks = response.get_result()\n", "\n", "print(json.dumps(secret_locks, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteSecretVersionLocksBulkOptions := secretsManagerService.NewDeleteSecretVersionLocksBulkOptions(\n", " secretIdForGetSecretLink,\n", " secretVersionIdForGetSecretVersionLink,\n", ")\n", "deleteSecretVersionLocksBulkOptions.SetName([]string{\"lock-example-1\"})\n", "\n", "secretLocks, response, err := secretsManagerService.DeleteSecretVersionLocksBulk(deleteSecretVersionLocksBulkOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secretLocks, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/configurations": { "post": { "summary": "Create a new configuration", "x-codegen-request-body-name": "ConfigurationPrototype", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/configuration", "description": "Create a new configuration", "action": "secrets-manager.configuration.create", "targetResourceType": "configuration" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.configuration.create" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.configuration.create" } ] }, "tags": [ "Configurations" ], "description": "Add a configuration to the specified secret type.\n\nUse this operation to define the configurations that are required to create public certificates (`public_cert`),\nprivate certificates (`private_cert`), IAM credentials secrets (`iam_credentials`) and custom credentials secrets (`custom_credentials`).\n\nYou can add multiple configurations for your instance as follows:\n\n- A single configuration for IAM credentials.\n- Up to 10 CA configurations for public certificates.\n- Up to 10 DNS configurations for public certificates.\n- Up to 10 Root CA configurations for private certificates.\n- Up to 10 Intermediate CA configurations for private certificates.\n- Up to 10 Certificate Template configurations for private certificates.", "x-cli-description": "Create a configuration and store it in your Secrets Manager instance.", "operationId": "create_configuration", "x-sdk-operations": { "request-examples": { "cli": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ibmcloud secrets-manager configuration-create --config-type=private_cert_configuration_root_ca \\\n", " --name=example-root-CA --certificate-common-name=example.com --private-cert-max-ttl=7365", "\n\n", "ibmcloud secrets-manager configuration-create --config-type=private_cert_configuration_root_ca --name=example-root-CA-HSM \\\n", "--certificate-common-name=example.com --private-cert-max-ttl=73654 \\\n", "--private-cert-crypto-key='{ \"provider\": { \"type\": \"hyper_protect_crypto_services\", \"instance_crn\": \"crn:v1:bluemix:public:hs-crypto:us-south:a/791f3fb10486421e97aa8512f18b7e65:b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5::\",\"pin_iam_credentials_secret_id\": \"14a7aff4-432d-11dc-a0f0-56a5b473394f\", \"private_keystore_id\": \"14a7aff4-432d-11dc-a0f0-56a5b473394f\" }, \"label\": \"cli-created\", \"allow_generate_key\": true }'", "\n\n", "ibmcloud secrets-manager configuration-create \\\n", " --configuration-prototype='{\"config_type\": \"private_cert_configuration_root_ca\", \"name\": \"example-root-CA\", \"max_ttl\": \"43830h\", \"crl_expiry\": \"72h\", \"crl_disable\": false, \"crl_distribution_points_encoded\": true, \"issuing_certificates_urls_encoded\": true, \"common_name\": \"example.com\", \"alt_names\": [\"alt-name-1\",\"alt-name-2\"], \"ip_sans\": \"127.0.0.1\", \"uri_sans\": \"https://www.example.com/test\", \"other_sans\": [\"1.2.3.5.4.3.201.10.4.3;utf8:test@example.com\"], \"ttl\": \"2190h\", \"format\": \"pem\", \"private_key_format\": \"der\", \"key_type\": \"rsa\", \"key_bits\": 4096, \"max_path_length\": -1, \"exclude_cn_from_sans\": false, \"permitted_dns_domains\": [\"exampleString\"], \"ou\": [\"exampleString\"], \"organization\": [\"exampleString\"], \"country\": [\"exampleString\"], \"locality\": [\"exampleString\"], \"province\": [\"exampleString\"], \"street_address\": [\"exampleString\"], \"postal_code\": [\"exampleString\"], \"serial_number\": \"d9:be:fe:35:ba:09:42:b5:35:ba:09:42:b5\"}'" ] } ] } ], "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"cloud_internet_services_apikey\": \"5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ\", \"cloud_internet_services_crn\": \"crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::\", \"config_type\": \"public_cert_configuration_dns_cloud_internet_services\", \"name\": \"example-cloud-internet-services-config\" }' \\\n", " \"/api/v2/configurations\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "PublicCertificateConfigurationDNSCloudInternetServicesPrototype configurationPrototypeModel = new PublicCertificateConfigurationDNSCloudInternetServicesPrototype.Builder()\n", " .configType(\"public_cert_configuration_dns_cloud_internet_services\")\n", " .name(\"example-cloud-internet-services-config\")\n", " .cloudInternetServicesApikey(\"5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ\")\n", " .cloudInternetServicesCrn(\"crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::\")\n", " .build();\n", "CreateConfigurationOptions createConfigurationOptions = new CreateConfigurationOptions.Builder()\n", " .configurationPrototype(configurationPrototypeModel)\n", " .build();\n", "\n", "Response response = secretsManagerService.createConfiguration(createConfigurationOptions).execute();\n", "Configuration configuration = response.getResult();\n", "\n", "System.out.println(configuration);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// PublicCertificateConfigurationDNSCloudInternetServicesPrototype\n", "const configurationPrototypeModel = {\n", " config_type: 'public_cert_configuration_dns_cloud_internet_services',\n", " name: 'example-cloud-internet-services-config',\n", " cloud_internet_services_apikey: '5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ',\n", " cloud_internet_services_crn: 'crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::',\n", "};\n", "\n", "const params = {\n", " configurationPrototype: configurationPrototypeModel,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.createConfiguration(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "configuration_prototype_model = {\n", " 'config_type': 'public_cert_configuration_dns_cloud_internet_services',\n", " 'name': 'example-cloud-internet-services-config',\n", " 'cloud_internet_services_apikey': '5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ',\n", " 'cloud_internet_services_crn': 'crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::',\n", "}\n", "\n", "response = secrets_manager_service.create_configuration(\n", " configuration_prototype=configuration_prototype_model,\n", ")\n", "configuration = response.get_result()\n", "\n", "print(json.dumps(configuration, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "configurationPrototypeModel := &secretsmanagerv2.PublicCertificateConfigurationDNSCloudInternetServicesPrototype{\n", " ConfigType: core.StringPtr(\"public_cert_configuration_dns_cloud_internet_services\"),\n", " Name: core.StringPtr(\"example-cloud-internet-services-config\"),\n", " CloudInternetServicesApikey: core.StringPtr(\"5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ\"),\n", " CloudInternetServicesCrn: core.StringPtr(\"crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::\"),\n", "}\n", "\n", "createConfigurationOptions := secretsManagerService.NewCreateConfigurationOptions(\n", " configurationPrototypeModel,\n", ")\n", "\n", "configuration, response, err := secretsManagerService.CreateConfiguration(createConfigurationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(configuration, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationPrototype" }, "examples": { "PublicCertificateConfigurationDNSCloudInternetServicesPrototype": { "$ref": "#/components/examples/PublicCertificateConfigurationDNSCloudInternetServicesPrototype" }, "PublicCertificateConfigurationDNSClassicInfrastructurePrototype": { "$ref": "#/components/examples/PublicCertificateConfigurationDNSClassicInfrastructurePrototype" }, "PublicCertificateConfigurationCALetsEncryptPrototype": { "$ref": "#/components/examples/PublicCertificateConfigurationCALetsEncryptPrototype" }, "PrivateCertificateConfigurationRootCAPrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationRootCAPrototype" }, "PrivateCertificateConfigurationRootCAwithHsmPrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationRootCAwithHsmPrototype" }, "PrivateCertificateConfigurationIntermediateCAPrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationIntermediateCAPrototype" }, "PrivateCertificateConfigurationIntermediateCAwithHsmPrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationIntermediateCAwithHsmPrototype" }, "PrivateCertificateConfigurationTemplatePrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationTemplatePrototype" }, "IAMCredentialsConfigurationPrototype": { "$ref": "#/components/examples/IAMCredentialsConfigurationPrototype" }, "CustomCredentialsConfigurationPrototype": { "$ref": "#/components/examples/CustomCredentialsConfigurationPrototype" } } } } }, "responses": { "201": { "description": "The configuration was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Configuration" }, "examples": { "PublicCertificateConfigurationDNSCloudInternetServices": { "$ref": "#/components/examples/PublicCertificateConfigurationDNSCloudInternetServices" }, "PublicCertificateConfigurationDNSClassicInfrastructure": { "$ref": "#/components/examples/PublicCertificateConfigurationDNSClassicInfrastructure" }, "PublicCertificateConfigurationCALetsEncrypt": { "$ref": "#/components/examples/PublicCertificateConfigurationCALetsEncrypt" }, "PrivateCertificateConfigurationRootCA": { "$ref": "#/components/examples/PrivateCertificateConfigurationRootCA" }, "PrivateCertificateConfigurationIntermediateCA": { "$ref": "#/components/examples/PrivateCertificateConfigurationIntermediateCA" }, "PrivateCertificateConfigurationTemplate": { "$ref": "#/components/examples/PrivateCertificateConfigurationTemplate" }, "IAMCredentialsConfiguration": { "$ref": "#/components/examples/IAMCredentialsConfiguration" }, "CustomCredentialsConfiguration": { "$ref": "#/components/examples/CustomCredentialsConfiguration" } } } }, "links": { "ConfigurationNameForGetConfiguration": { "$ref": "#/components/links/ConfigurationNameForGetConfiguration" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } } }, "get": { "summary": "List configurations", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/configurations", "description": "List configurations", "action": "secrets-manager.configurations.list" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.configurations.list" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.configurations.list" } ] }, "tags": [ "Configurations" ], "description": "List the configurations that are available in your Secrets Manager instance.", "x-cli-description": "List the configurations that are available in your Secrets Manager instance.", "x-cli-table-filter-jmespath": "configurations[*].{Created_At:created_at,Name:name,Config_Type:config_type,Secret_Type:secret_type,Created_By:created_by,Updated_At:updated_at}", "operationId": "list_configurations", "parameters": [ { "$ref": "#/components/parameters/ConfigurationCollectionOffsetParam" }, { "$ref": "#/components/parameters/ConfigurationCollectionLimitParam" }, { "$ref": "#/components/parameters/ConfigurationCollectionSortParam" }, { "$ref": "#/components/parameters/ConfigurationCollectionSearchParam" }, { "$ref": "#/components/parameters/ConfigurationCollectionSecretTypesParam" } ], "responses": { "200": { "description": "The list of configurations was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationMetadataPaginatedCollection" }, "examples": { "ConfigurationMetadataCollection": { "$ref": "#/components/examples/ConfigurationMetadataCollection" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/configurations?sort=config_type&search=example&secret_types=[ \\\"iam_credentials\\\", \\\"public_cert\\\", \\\"private_cert\\\", \\\"custom_credentials\\\" ]\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ListConfigurationsOptions listConfigurationsOptions = new ListConfigurationsOptions.Builder()\n", " .limit(Long.valueOf(\"10\"))\n", " .sort(\"config_type\")\n", " .search(\"example\")\n", " .secretTypes(java.util.Arrays.asList(\"iam_credentials\", \"public_cert\", \"private_cert\", \"custom_credentials\"))\n", " .build();\n", "\n", "ConfigurationsPager pager = new ConfigurationsPager(secretsManagerService, listConfigurationsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " limit: 10,\n", " sort: 'config_type',\n", " search: 'example',\n", " secretTypes: ['iam_credentials', 'public_cert', 'private_cert', 'custom_credentials'],\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new SecretsManagerV2.ConfigurationsPager(secretsManagerService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "all_results = []\n", "pager = ConfigurationsPager(\n", " client=secrets_manager_service,\n", " limit=10,\n", " sort='config_type',\n", " search='example',\n", " secret_types=['iam_credentials', 'public_cert', 'private_cert', 'custom_credentials'],\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listConfigurationsOptions := &secretsmanagerv2.ListConfigurationsOptions{\n", " Limit: core.Int64Ptr(int64(10)),\n", " Sort: core.StringPtr(\"config_type\"),\n", " Search: core.StringPtr(\"example\"),\n", " SecretTypes: []string{\"iam_credentials\", \"public_cert\", \"private_cert\", \"custom_credentials\"},\n", "}\n", "\n", "pager, err := secretsManagerService.NewConfigurationsPager(listConfigurationsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []secretsmanagerv2.ConfigurationMetadataIntf\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/configurations/{name}": { "parameters": [ { "$ref": "#/components/parameters/ConfigurationName" }, { "$ref": "#/components/parameters/AcceptConfigurationType" } ], "get": { "summary": "Get a configuration", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/configuration", "description": "View the details of a configuration", "targetResourceType": "configuration", "action": "secrets-manager.configuration.read" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.configuration.read" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.configuration.read" } ] }, "tags": [ "Configurations" ], "description": "Get a configuration by specifying its name.\n\nA successful request returns the details of your configuration.", "x-cli-description": "Get a configuration. This command returns the details of your configuration.", "operationId": "get_configuration", "responses": { "200": { "description": "The configuration was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Configuration" }, "examples": { "PublicCertificateConfigurationDNSCloudInternetServices": { "$ref": "#/components/examples/PublicCertificateConfigurationDNSCloudInternetServices" }, "PublicCertificateConfigurationDNSClassicInfrastructure": { "$ref": "#/components/examples/PublicCertificateConfigurationDNSClassicInfrastructure" }, "PublicCertificateConfigurationCALetsEncrypt": { "$ref": "#/components/examples/PublicCertificateConfigurationCALetsEncrypt" }, "PrivateCertificateConfigurationRootCA": { "$ref": "#/components/examples/PrivateCertificateConfigurationRootCA" }, "PrivateCertificateConfigurationIntermediateCA": { "$ref": "#/components/examples/PrivateCertificateConfigurationIntermediateCA" }, "PrivateCertificateConfigurationTemplate": { "$ref": "#/components/examples/PrivateCertificateConfigurationTemplate" }, "IAMCredentialsConfiguration": { "$ref": "#/components/examples/IAMCredentialsConfiguration" }, "CustomCredentialsConfiguration": { "$ref": "#/components/examples/CustomCredentialsConfiguration" } } } } }, "300": { "$ref": "#/components/responses/MultipleChoices" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/configurations/configurationNameForGetConfigurationLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "GetConfigurationOptions getConfigurationOptions = new GetConfigurationOptions.Builder()\n", " .name(configurationNameForGetConfigurationLink)\n", " .xSmAcceptConfigurationType(\"public_cert_configuration_dns_cloud_internet_services\")\n", " .build();\n", "\n", "Response response = secretsManagerService.getConfiguration(getConfigurationOptions).execute();\n", "Configuration configuration = response.getResult();\n", "\n", "System.out.println(configuration);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " name: configurationNameForGetConfigurationLink,\n", " xSmAcceptConfigurationType: 'public_cert_configuration_dns_cloud_internet_services',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.getConfiguration(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.get_configuration(\n", " name=configuration_name_for_get_configuration_link,\n", " x_sm_accept_configuration_type='public_cert_configuration_dns_cloud_internet_services',\n", ")\n", "configuration = response.get_result()\n", "\n", "print(json.dumps(configuration, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getConfigurationOptions := secretsManagerService.NewGetConfigurationOptions(\n", " configurationNameForGetConfigurationLink,\n", ")\n", "getConfigurationOptions.SetXSmAcceptConfigurationType(\"public_cert_configuration_dns_cloud_internet_services\")\n", "\n", "configuration, response, err := secretsManagerService.GetConfiguration(getConfigurationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(configuration, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "patch": { "summary": "Update configuration", "x-codegen-request-body-name": "ConfigurationPatch", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/configuration", "description": "Update a configuration.", "targetResourceType": "configuration", "action": "secrets-manager.configuration.update" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.configuration.update" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.configuration.update" } ] }, "tags": [ "Configurations" ], "description": "Update a configuration.", "x-cli-description": "Update a configuration.", "operationId": "update_configuration", "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/ConfigurationPatch" }, "examples": { "PublicCertificateConfigurationDNSCloudInternetServicesPatch": { "$ref": "#/components/examples/PublicCertificateConfigurationDNSCloudInternetServicesPatch" }, "PublicCertificateConfigurationDNSClassicInfrastructurePatch": { "$ref": "#/components/examples/PublicCertificateConfigurationDNSClassicInfrastructurePatch" }, "PublicCertificateConfigurationCALetsEncryptPatch": { "$ref": "#/components/examples/PublicCertificateConfigurationCALetsEncryptPatch" }, "PrivateCertificateConfigurationRootCAPatch": { "$ref": "#/components/examples/PrivateCertificateConfigurationRootCAPatch" }, "PrivateCertificateConfigurationIntermediateCAPatch": { "$ref": "#/components/examples/PrivateCertificateConfigurationIntermediateCAPatch" }, "PrivateCertificateConfigurationTemplatePatch": { "$ref": "#/components/examples/PrivateCertificateConfigurationTemplatePatch" }, "IAMCredentialsConfigurationPatch": { "$ref": "#/components/examples/IAMCredentialsConfigurationPatch" }, "CustomCredentialsConfigurationPatch": { "$ref": "#/components/examples/CustomCredentialsConfigurationPatch" } } } } }, "responses": { "200": { "description": "The configuration was successfully updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Configuration" }, "examples": { "PublicCertificateConfigurationDNSCloudInternetServices": { "$ref": "#/components/examples/PublicCertificateConfigurationDNSCloudInternetServices" }, "PublicCertificateConfigurationDNSClassicInfrastructure": { "$ref": "#/components/examples/PublicCertificateConfigurationDNSClassicInfrastructure" }, "PublicCertificateConfigurationCALetsEncrypt": { "$ref": "#/components/examples/PublicCertificateConfigurationCALetsEncrypt" }, "PrivateCertificateConfigurationRootCA": { "$ref": "#/components/examples/PrivateCertificateConfigurationRootCA" }, "PrivateCertificateConfigurationIntermediateCA": { "$ref": "#/components/examples/PrivateCertificateConfigurationIntermediateCA" }, "PrivateCertificateConfigurationTemplate": { "$ref": "#/components/examples/PrivateCertificateConfigurationTemplate" }, "IAMCredentialsConfiguration": { "$ref": "#/components/examples/IAMCredentialsConfiguration" }, "CustomCredentialsConfiguration": { "$ref": "#/components/examples/CustomCredentialsConfiguration" } } } } }, "300": { "$ref": "#/components/responses/MultipleChoices" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/merge-patch+json\" \\\n", " --data '{\"cloud_internet_services_apikey\":\"5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ\",\"cloud_internet_services_crn\":\"crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::\"}' \\\n", " \"/api/v2/configurations/configurationNameForGetConfigurationLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "PublicCertificateConfigurationDNSCloudInternetServicesPatch configurationPatchModel = new PublicCertificateConfigurationDNSCloudInternetServicesPatch.Builder()\n", " .cloudInternetServicesApikey(\"5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ\")\n", " .cloudInternetServicesCrn(\"crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::\")\n", " .build();\n", "Map configurationPatchModelAsPatch = configurationPatchModel.asPatch();\n", "UpdateConfigurationOptions updateConfigurationOptions = new UpdateConfigurationOptions.Builder()\n", " .name(configurationNameForGetConfigurationLink)\n", " .configurationPatch(configurationPatchModelAsPatch)\n", " .xSmAcceptConfigurationType(\"public_cert_configuration_dns_cloud_internet_services\")\n", " .build();\n", "\n", "Response response = secretsManagerService.updateConfiguration(updateConfigurationOptions).execute();\n", "Configuration configuration = response.getResult();\n", "\n", "System.out.println(configuration);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// PublicCertificateConfigurationDNSCloudInternetServicesPatch\n", "const configurationPatchModel = {\n", " cloud_internet_services_apikey: '5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ',\n", " cloud_internet_services_crn: 'crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::',\n", "};\n", "\n", "const params = {\n", " name: configurationNameForGetConfigurationLink,\n", " configurationPatch: configurationPatchModel,\n", " xSmAcceptConfigurationType: 'public_cert_configuration_dns_cloud_internet_services',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.updateConfiguration(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "configuration_patch_model = {\n", " 'cloud_internet_services_apikey': '5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ',\n", " 'cloud_internet_services_crn': 'crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::',\n", "}\n", "\n", "response = secrets_manager_service.update_configuration(\n", " name=configuration_name_for_get_configuration_link,\n", " configuration_patch=configuration_patch_model,\n", " x_sm_accept_configuration_type='public_cert_configuration_dns_cloud_internet_services',\n", ")\n", "configuration = response.get_result()\n", "\n", "print(json.dumps(configuration, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "configurationPatchModel := &secretsmanagerv2.PublicCertificateConfigurationDNSCloudInternetServicesPatch{\n", " CloudInternetServicesApikey: core.StringPtr(\"5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ\"),\n", " CloudInternetServicesCrn: core.StringPtr(\"crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::\"),\n", "}\n", "configurationPatchModelAsPatch, asPatchErr := configurationPatchModel.AsPatch()\n", "Expect(asPatchErr).To(BeNil())\n", "\n", "updateConfigurationOptions := secretsManagerService.NewUpdateConfigurationOptions(\n", " configurationNameForGetConfigurationLink,\n", " configurationPatchModelAsPatch,\n", ")\n", "updateConfigurationOptions.SetXSmAcceptConfigurationType(\"public_cert_configuration_dns_cloud_internet_services\")\n", "\n", "configuration, response, err := secretsManagerService.UpdateConfiguration(updateConfigurationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(configuration, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "summary": "Delete a configuration", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/configuration", "description": "Delete a configuration", "targetResourceType": "configuration", "action": "secrets-manager.configuration.delete" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.configuration.delete" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.configuration.delete" } ] }, "tags": [ "Configurations" ], "description": "Delete a configuration by specifying its name.", "x-cli-description": "Delete a configuration.", "operationId": "delete_configuration", "responses": { "204": { "description": "The configuration was successfully deleted." }, "300": { "$ref": "#/components/responses/MultipleChoices" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"/api/v2/configurations/configurationNameForGetConfigurationLink\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "DeleteConfigurationOptions deleteConfigurationOptions = new DeleteConfigurationOptions.Builder()\n", " .name(configurationNameForGetConfigurationLink)\n", " .xSmAcceptConfigurationType(\"public_cert_configuration_dns_cloud_internet_services\")\n", " .build();\n", "\n", "Response response = secretsManagerService.deleteConfiguration(deleteConfigurationOptions).execute();" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " name: configurationNameForGetConfigurationLink,\n", " xSmAcceptConfigurationType: 'public_cert_configuration_dns_cloud_internet_services',\n", "};\n", "\n", "try {\n", " await secretsManagerService.deleteConfiguration(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.delete_configuration(\n", " name=configuration_name_for_get_configuration_link,\n", " x_sm_accept_configuration_type='public_cert_configuration_dns_cloud_internet_services',\n", ")" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteConfigurationOptions := secretsManagerService.NewDeleteConfigurationOptions(\n", " configurationNameForGetConfigurationLink,\n", ")\n", "deleteConfigurationOptions.SetXSmAcceptConfigurationType(\"public_cert_configuration_dns_cloud_internet_services\")\n", "\n", "response, err := secretsManagerService.DeleteConfiguration(deleteConfigurationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteConfiguration(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } } }, "/api/v2/configurations/{name}/actions": { "parameters": [ { "$ref": "#/components/parameters/ConfigurationName" }, { "$ref": "#/components/parameters/AcceptConfigurationType" } ], "post": { "summary": "Create a configuration action", "x-codegen-request-body-name": "ConfigActionPrototype", "x-activity-tracker": { "dataEvent": true, "targetTypeURI": "secrets-manager/configuration-action", "description": "Create a configuration action", "targetResourceType": "configuration", "action": "secrets-manager.configuration-action.create" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.configuration-action.create" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.configuration-action.create" } ] }, "tags": [ "Configurations" ], "description": "Create a configuration action. This operation supports the following actions:\n\n- `private_cert_configuration_action_sign_intermediate`: Sign an intermediate certificate authority.\n- `private_cert_configuration_action_sign_csr`: Sign a certificate signing request.\n- `private_cert_configuration_action_set_signed`: Set a signed intermediate certificate authority.\n- `private_cert_configuration_action_revoke_ca_certificate`: Revoke an internally signed intermediate certificate authority certificate.\n- `private_cert_configuration_action_rotate_crl`: Rotate the certificate revocation list (CRL) of an intermediate certificate authority.\n- `private_cert_configuration_action_rotate_intermediate`: Rotate an internally signed intermediate certificate authority certificate.", "x-cli-description": "Create an action on a configuration.", "operationId": "create_configuration_action", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationActionPrototype" }, "examples": { "PrivateCertificateConfigurationActionRotateCRLPrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionRotateCRLPrototype" }, "PrivateCertificateConfigurationActionRevokePrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionRevokePrototype" }, "PrivateCertificateConfigurationActionRotatePrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionRotatePrototype" }, "PrivateCertificateConfigurationActionSignCSRPrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionSignCSRPrototype" }, "PrivateCertificateConfigurationActionSignIntermediatePrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionSignIntermediatePrototype" }, "PrivateCertificateConfigurationActionSetSignedPrototype": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionSetSignedPrototype" } } } } }, "responses": { "201": { "description": "The version action was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationAction" }, "examples": { "PrivateCertificateConfigurationActionRotateCRL": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionRotateCRL" }, "PrivateCertificateConfigurationActionRevoke": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionRevoke" }, "PrivateCertificateConfigurationActionRotate": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionRotate" }, "PrivateCertificateConfigurationActionSignCSR": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionSignCSR" }, "PrivateCertificateConfigurationActionSignIntermediate": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionSignIntermediate" }, "PrivateCertificateConfigurationActionSetSigned": { "$ref": "#/components/examples/PrivateCertificateConfigurationActionSetSigned" } } } } }, "300": { "$ref": "#/components/responses/MultipleChoices" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"action_type\": \"private_cert_configuration_action_rotate_crl\" }' \\\n", " \"/api/v2/configurations/configurationNameForGetConfigurationLink/actions\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "PrivateCertificateConfigurationActionRotateCRLPrototype configurationActionPrototypeModel = new PrivateCertificateConfigurationActionRotateCRLPrototype.Builder()\n", " .actionType(\"private_cert_configuration_action_rotate_crl\")\n", " .build();\n", "CreateConfigurationActionOptions createConfigurationActionOptions = new CreateConfigurationActionOptions.Builder()\n", " .name(configurationNameForGetConfigurationLink)\n", " .configActionPrototype(configurationActionPrototypeModel)\n", " .xSmAcceptConfigurationType(\"public_cert_configuration_dns_cloud_internet_services\")\n", " .build();\n", "\n", "Response response = secretsManagerService.createConfigurationAction(createConfigurationActionOptions).execute();\n", "ConfigurationAction configurationAction = response.getResult();\n", "\n", "System.out.println(configurationAction);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "// Request models needed by this operation.\n", "\n", "// PrivateCertificateConfigurationActionRotateCRLPrototype\n", "const configurationActionPrototypeModel = {\n", " action_type: 'private_cert_configuration_action_rotate_crl',\n", "};\n", "\n", "const params = {\n", " name: configurationNameForGetConfigurationLink,\n", " configActionPrototype: configurationActionPrototypeModel,\n", " xSmAcceptConfigurationType: 'public_cert_configuration_dns_cloud_internet_services',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.createConfigurationAction(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "configuration_action_prototype_model = {\n", " 'action_type': 'private_cert_configuration_action_rotate_crl',\n", "}\n", "\n", "response = secrets_manager_service.create_configuration_action(\n", " name=configuration_name_for_get_configuration_link,\n", " config_action_prototype=configuration_action_prototype_model,\n", " x_sm_accept_configuration_type='public_cert_configuration_dns_cloud_internet_services',\n", ")\n", "configuration_action = response.get_result()\n", "\n", "print(json.dumps(configuration_action, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "configurationActionPrototypeModel := &secretsmanagerv2.PrivateCertificateConfigurationActionRotateCRLPrototype{\n", " ActionType: core.StringPtr(\"private_cert_configuration_action_rotate_crl\"),\n", "}\n", "\n", "createConfigurationActionOptions := secretsManagerService.NewCreateConfigurationActionOptions(\n", " configurationNameForGetConfigurationLink,\n", " configurationActionPrototypeModel,\n", ")\n", "createConfigurationActionOptions.SetXSmAcceptConfigurationType(\"public_cert_configuration_dns_cloud_internet_services\")\n", "\n", "configurationAction, response, err := secretsManagerService.CreateConfigurationAction(createConfigurationActionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(configurationAction, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/api/v2/notifications/registration": { "post": { "summary": "Register with Event Notifications instance", "x-codegen-request-body-name": "NotificationsRegistrationPrototype", "description": "Create a registration between a Secrets Manager instance and [Event Notifications](https://cloud.ibm.com/apidocs/event-notifications).\n\nA successful request adds Secrets Manager as a source that you can reference from your Event Notifications\ninstance. For more information about enabling notifications for Secrets Manager, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-event-notifications).", "x-activity-tracker": { "dataEvent": false, "targetTypeURI": "secrets-manager/notifications", "description": "Register with an Event Notifications instance", "action": "secrets-manager.notifications-registration.create" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.notifications-registration.create" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.notifications-registration.create" } ] }, "tags": [ "Notifications" ], "operationId": "create_notifications_registration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsRegistrationPrototype" }, "examples": { "NotificationsRegistrationPrototype": { "$ref": "#/components/examples/NotificationsRegistrationPrototype" } } } } }, "responses": { "201": { "description": "The notification registration was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsRegistration" }, "examples": { "NotificationsRegistration": { "$ref": "#/components/examples/NotificationsRegistration" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"event_notifications_instance_crn\": \"crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::\", \"event_notifications_source_description\": \"Optional description of this source in an Event Notifications instance.\", \"event_notifications_source_name\": \"My Secrets Manager\" }' \\\n", " \"/api/v2/notifications/registration\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "CreateNotificationsRegistrationOptions createNotificationsRegistrationOptions = new CreateNotificationsRegistrationOptions.Builder()\n", " .eventNotificationsInstanceCrn(\"crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::\")\n", " .eventNotificationsSourceName(\"My Secrets Manager\")\n", " .eventNotificationsSourceDescription(\"Optional description of this source in an Event Notifications instance.\")\n", " .build();\n", "\n", "Response response = secretsManagerService.createNotificationsRegistration(createNotificationsRegistrationOptions).execute();\n", "NotificationsRegistration notificationsRegistration = response.getResult();\n", "\n", "System.out.println(notificationsRegistration);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const params = {\n", " eventNotificationsInstanceCrn: 'crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::',\n", " eventNotificationsSourceName: 'My Secrets Manager',\n", " eventNotificationsSourceDescription: 'Optional description of this source in an Event Notifications instance.',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await secretsManagerService.createNotificationsRegistration(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.create_notifications_registration(\n", " event_notifications_instance_crn='crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::',\n", " event_notifications_source_name='My Secrets Manager',\n", " event_notifications_source_description='Optional description of this source in an Event Notifications instance.',\n", ")\n", "notifications_registration = response.get_result()\n", "\n", "print(json.dumps(notifications_registration, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "createNotificationsRegistrationOptions := secretsManagerService.NewCreateNotificationsRegistrationOptions(\n", " \"crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::\",\n", " \"My Secrets Manager\",\n", ")\n", "createNotificationsRegistrationOptions.SetEventNotificationsSourceDescription(\"Optional description of this source in an Event Notifications instance.\")\n", "\n", "notificationsRegistration, response, err := secretsManagerService.CreateNotificationsRegistration(createNotificationsRegistrationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(notificationsRegistration, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "get": { "summary": "Get Event Notifications registration details", "description": "Get the details of the registration between your Secrets Manager instance and Event Notifications.", "x-activity-tracker": { "dataEvent": false, "targetTypeURI": "secrets-manager/notifications", "description": "Get Event Notifications registration details", "action": "secrets-manager.notifications-registration.read" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.notifications-registration.read" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.notifications-registration.read" } ] }, "tags": [ "Notifications" ], "operationId": "get_notifications_registration", "responses": { "200": { "description": "The registration details were successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsRegistration" }, "examples": { "NotificationsRegistration": { "$ref": "#/components/examples/NotificationsRegistration" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"/api/v2/notifications/registration\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "GetNotificationsRegistrationOptions getNotificationsRegistrationOptions = new GetNotificationsRegistrationOptions();\n", "\n", "Response response = secretsManagerService.getNotificationsRegistration(getNotificationsRegistrationOptions).execute();\n", "NotificationsRegistration notificationsRegistration = response.getResult();\n", "\n", "System.out.println(notificationsRegistration);" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "let res;\n", "try {\n", " res = await secretsManagerService.getNotificationsRegistration({});\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.get_notifications_registration()\n", "notifications_registration = response.get_result()\n", "\n", "print(json.dumps(notifications_registration, indent=2))" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getNotificationsRegistrationOptions := secretsManagerService.NewGetNotificationsRegistrationOptions()\n", "\n", "notificationsRegistration, response, err := secretsManagerService.GetNotificationsRegistration(getNotificationsRegistrationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(notificationsRegistration, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "summary": "Unregister from Event Notifications instance", "description": "Delete the registration between your Secrets Manager instance and Event Notifications.\n\nA successful request removes your Secrets Manager instance as a source in Event Notifications.", "x-activity-tracker": { "dataEvent": false, "targetTypeURI": "secrets-manager/notifications", "description": "Unregister from Event Notifications", "action": "secrets-manager.notifications-registration.delete" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.notifications-registration.delete" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.notifications-registration.delete" } ] }, "tags": [ "Notifications" ], "operationId": "delete_notifications_registration", "responses": { "204": { "description": "The registration was successfully deleted." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"/api/v2/notifications/registration\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "DeleteNotificationsRegistrationOptions deleteNotificationsRegistrationOptions = new DeleteNotificationsRegistrationOptions();\n", "\n", "Response response = secretsManagerService.deleteNotificationsRegistration(deleteNotificationsRegistrationOptions).execute();" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " await secretsManagerService.deleteNotificationsRegistration({});\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.delete_notifications_registration()" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteNotificationsRegistrationOptions := secretsManagerService.NewDeleteNotificationsRegistrationOptions()\n", "\n", "response, err := secretsManagerService.DeleteNotificationsRegistration(deleteNotificationsRegistrationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteNotificationsRegistration(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } } }, "/api/v2/notifications/registration/test": { "get": { "summary": "Send a test event for Event Notifications registrations", "description": "Send a test event from a Secrets Manager instance to a configured [Event Notifications](https://cloud.ibm.com/apidocs/event-notifications)\ninstance.\n\nA successful request sends a test event to the Event Notifications instance. For more information about enabling\nnotifications for Secrets Manager, check out the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-event-notifications).", "x-activity-tracker": { "dataEvent": false, "targetTypeURI": "secrets-manager/notifications", "description": "Send a test event for Event Notifications registrations", "action": "secrets-manager.notifications-registration.test" }, "x-ibm-permissions": { "actions": [ { "name": "secrets-manager.notifications-registration.test" } ] }, "x-ibm-events": { "events": [ { "name": "secrets-manager.notifications-registration.test" } ] }, "tags": [ "Notifications" ], "operationId": "get_notifications_registration_test", "responses": { "204": { "description": "The test event was successfully sent to Event Notifications." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ServiceUnavailableError" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"/api/v2/notifications/registration/test\"" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "GetNotificationsRegistrationTestOptions getNotificationsRegistrationTestOptions = new GetNotificationsRegistrationTestOptions();\n", "\n", "Response response = secretsManagerService.getNotificationsRegistrationTest(getNotificationsRegistrationTestOptions).execute();" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " await secretsManagerService.getNotificationsRegistrationTest({});\n", "} catch (err) {\n", " console.warn(err);\n", "}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = secrets_manager_service.get_notifications_registration_test()" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getNotificationsRegistrationTestOptions := secretsManagerService.NewGetNotificationsRegistrationTestOptions()\n", "\n", "response, err := secretsManagerService.GetNotificationsRegistrationTest(getNotificationsRegistrationTestOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from GetNotificationsRegistrationTest(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Your IBM Cloud access token.", "bearerFormat": "JWT" } }, "parameters": { "SecretGroupId": { "name": "id", "in": "path", "description": "The UUID that uniquely identifies your secret group.", "x-cli-description": "The ID of the secret group.", "schema": { "$ref": "#/components/schemas/SecretGroupId" }, "required": true, "x-linkback": "#/components/links/SecretGroupIdForGetSecretGroup", "example": "d898bb90-82f6-4d61-b5cc-b079b66cfa76" }, "SecretGroupIdNoDefault": { "name": "id", "in": "path", "description": "The UUID that uniquely identifies your secret group.", "x-cli-description": "The ID of the secret group.", "schema": { "$ref": "#/components/schemas/Uuid" }, "required": true, "x-linkback": "#/components/links/SecretGroupIdForGetSecretGroup", "example": "d898bb90-82f6-4d61-b5cc-b079b66cfa76" }, "SecretGroupName": { "name": "secret_group_name", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SecretGroupNameV1Compatible" }, "description": "The name of your secret group.", "example": "default" }, "SecretId": { "name": "id", "in": "path", "description": "The UUID that uniquely identifies your secret.", "x-cli-description": "The ID of the secret.", "schema": { "$ref": "#/components/schemas/Uuid" }, "required": true, "x-linkback": "#/components/links/SecretIdForGetSecret", "example": "0b5571f7-21e6-42b7-91c5-3f5ac9793a46" }, "SecretQualifiedId": { "name": "secret_id", "in": "path", "description": "The UUID that uniquely identifies your secret.", "x-cli-description": "The ID of the secret.", "schema": { "$ref": "#/components/schemas/Uuid" }, "required": true, "x-linkback": "#/components/links/SecretIdForGetSecret", "example": "0b5571f7-21e6-42b7-91c5-3f5ac9793a46" }, "SecretVersionId": { "name": "id", "in": "path", "description": "The UUID that uniquely identifies your secret version. You can use the `current` or `previous` aliases to refer to the current or previous secret version.", "x-cli-description": "The ID of the secret version.", "schema": { "$ref": "#/components/schemas/SecretVersionId" }, "required": true, "x-linkback": "#/components/links/SecretVersionIdForGetSecretVersion", "example": "eb4cf24d-9cae-424b-945e-159788a5f535" }, "TaskId": { "name": "id", "in": "path", "required": true, "description": "The ID that uniquely identifies your task.", "x-cli-description": "The ID that uniquely identifies your task.", "schema": { "$ref": "#/components/schemas/TaskId" }, "example": "sm-task-a436bebd-dbbd-5c0d-ab35-1232f1234f95" }, "LocksCollectionLimitParam": { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "default": 25 }, "required": false, "description": "The number of locks with associated secret to retrieve. By default, list operations return the first 25 items. To retrieve a different set\nof items, use `limit` with `offset` to page through your available resources.\n\n**Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5, use\n`..?limit=5`.", "x-cli-description": "The number of secrets with locks to list." }, "LocksCollectionSearchParam": { "name": "search", "in": "query", "schema": { "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 128 }, "required": false, "description": "Filter locks that contain the specified string in the field \"name\".\n\n**Usage:** If you want to list only the locks that contain the string \"text\" in the field \"name\", use\n`..?search=text`.\n", "x-cli-description": "Filter locks that contain the specified string in the field \"name\".", "example": "example" }, "LocksCollectionOffsetParam": { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 1000, "default": 0 }, "required": false, "description": "The number of locks to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset`\nvalue. Use `offset` with `limit` to page through your available resources.\n\n**Usage:** If you have 100 locks on your secret, and you want to retrieve locks 26 through 50, use\n`..?offset=25&limit=25`.", "x-cli-description": "The number of locks to skip." }, "LocksCollectionSortParam": { "name": "sort", "in": "query", "schema": { "type": "string", "pattern": "^-?(created_at|updated_at|name)$", "minLength": 4, "maxLength": 17 }, "required": false, "description": "Sort a collection of locks by the specified field in ascending order. To sort in descending order use the `-` character\n\n**Available values:** created_at | updated_at | name\n\n**Usage:** To sort a list of locks by their creation date, use\n`../locks?sort=created_at`.", "example": "name", "x-cli-description": "Sort a collection of locks by the specified field in ascending order. To sort in descending order use the `-` character" }, "SecretCollectionOffsetParam": { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10000000, "default": 0 }, "required": false, "description": "The number of secrets to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset`\nvalue. Use `offset` with `limit` to page through your available resources.\n\n**Usage:** If you have 100 secrets in your instance, and you want to retrieve secrets 26 through 50, use\n`..?offset=25&limit=25`.", "x-cli-description": "The number of secrets to skip." }, "SecretCollectionLimitParam": { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 200 }, "required": false, "description": "The number of secrets to retrieve. By default, list operations return the first 200 items. To retrieve a different set\nof items, use `limit` with `offset` to page through your available resources. Maximum limit allowed is 1000 secrets.\n\n**Usage:** If you want to retrieve only the first 25 secrets in your instance, use\n`..?limit=25`.", "x-cli-description": "The number of secrets to list." }, "SecretCollectionSortParam": { "name": "sort", "in": "query", "schema": { "type": "string", "pattern": "^-?(id|created_at|updated_at|retrieved_at|expiration_date|secret_type|name)$", "minLength": 2, "maxLength": 17 }, "required": false, "description": "Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the `-` character\n\n\n**Available values:** id | created_at | updated_at | retrieved_at | expiration_date | secret_type | name\n\n**Usage:** To sort a list of secrets by their creation date, use\n`../secrets?sort=created_at`.", "example": "created_at", "x-cli-description": "Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the `-` character" }, "SecretCollectionSearchParam": { "name": "search", "in": "query", "schema": { "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 128 }, "required": false, "description": "Obtain a collection of secrets that contain the specified string in one or more of the fields: `id`, `name`, `description`,\n`labels`, `secret_type`.\n\n**Usage:** If you want to list only the secrets that contain the string `text`, use\n`../secrets?search=text`.\n", "x-cli-description": "Filter secrets that contain the specified string in one or more of these fields: \"id\", \"name\", \"description\",\"labels\", \"secret_type\".", "example": "example" }, "SecretCollectionGroupsParam": { "name": "groups", "in": "query", "style": "form", "explode": false, "example": [ "default", "cac40995-c37a-4dcb-9506-472869077634" ], "schema": { "type": "array", "minItems": 0, "maxItems": 201, "items": { "$ref": "#/components/schemas/GroupsFilterParam" } }, "description": "Filter secrets by groups.\n\nYou can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets\nthat are in the default secret group, use the `default` keyword.\n\n**Usage:** To retrieve a list of secrets that are associated with an existing secret group or the default group,\nuse `..?groups={secret_group_ID},default`.", "x-cli-description": "Filter secrets by groups. Provide the IDs of the groups to filter by." }, "ConfigurationCollectionOffsetParam": { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 1000, "default": 0 }, "required": false, "description": "The number of configurations to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset`\nvalue. Use `offset` with `limit` to page through your available resources.\n\n**Usage:** If you have 100 configurations in your instance, and you want to retrieve configurations 26 through 50, use\n`..?offset=25&limit=25`.", "x-cli-description": "The number of configurations to skip." }, "ConfigurationCollectionLimitParam": { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 200 }, "required": false, "description": "The number of configurations to retrieve. By default, list operations return the first 200 items. To retrieve a different set\nof items, use `limit` with `offset` to page through your available resources. Maximum limit allowed is 1000 secrets.\n\n**Usage:** If you want to retrieve only the first 25 configurations in your instance, use\n`..?limit=25`.", "x-cli-description": "The number of configurations to list." }, "ConfigurationCollectionSortParam": { "name": "sort", "in": "query", "schema": { "type": "string", "pattern": "^-?(config_type|secret_type|name)$", "minLength": 2, "maxLength": 17 }, "required": false, "description": "Sort a collection of configurations by the specified field in ascending order. To sort in descending order use the `-` character\n\n\n**Available values:** config_type | secret_type | name\n\n**Usage:** To sort a list of configurations by their creation date, use\n`../configurations?sort=config_type`.", "example": "config_type", "x-cli-description": "Sort a collection of configurations by the specified field in ascending order. To sort in descending order use the `-` character" }, "ConfigurationCollectionSearchParam": { "name": "search", "in": "query", "schema": { "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 128 }, "required": false, "description": "Obtain a collection of configurations that contain the specified string in one or more of the fields: `name`, `config_type`, `secret_type`.\n\n**Usage:** If you want to list only the configurations that contain the string `text`, use\n`../configurations?search=text`.\n", "x-cli-description": "Filter configurations that contain the specified string in one or more of the fields: \"name\", \"config_type\", \"secret_type\".", "example": "example" }, "ConfigurationCollectionSecretTypesParam": { "name": "secret_types", "in": "query", "style": "form", "explode": false, "example": [ "iam_credentials", "public_cert", "private_cert", "custom_credentials" ], "schema": { "type": "array", "minItems": 0, "maxItems": 4, "items": { "$ref": "#/components/schemas/SecretTypeConfigurationFilterParam" } }, "description": "Filter configurations by secret types, iam_credentials, public_cert or private_cert.\n\nYou can apply multiple filters by using a comma-separated list of secret types.\n\n**Usage:** To retrieve a list of configurations that are associated with all secret types,\nuse `..?secret_types=iam_credentials,public_cert,private_cert,custom_credentials`.", "x-cli-description": "Filter configurations by secret types. Provide one or more of the following secret types: iam_credentials, public_cert, private_cert or custom_credentials." }, "SecretCollectionTypesParam": { "name": "secret_types", "in": "query", "style": "form", "explode": false, "allowEmptyValue": true, "example": [ "arbitrary", "kv" ], "schema": { "type": "array", "minItems": 0, "maxItems": 9, "items": { "$ref": "#/components/schemas/SecretTypeFilterParam" } }, "description": "Filter secrets by types.\n\nYou can apply multiple filters by using a comma-separated list of secret types. \n\n**Usage:** To retrieve a list of imported certificates and public certificates\nuse `..?secret_types=imported_cert,public_cert`.", "x-cli-description": "Filter secrets by types. Provide the secret types to filter by." }, "SecretCollectionLabelsParam": { "name": "match_all_labels", "in": "query", "style": "form", "explode": false, "example": [ "dev", "us-south" ], "schema": { "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/LabelFilterParam" } }, "description": "Filter secrets by labels.\n\nYou can use a comma-separated list of labels to filter secrets that include all of the labels in the list.\n\n**Usage:** To retrieve a list of secrets that include both the label \"dev\" and the label \"us-south\" in their list of labels,\nuse `..?labels=dev,us-south`.", "x-cli-description": "Filter secrets by labels. Provide the labels to filter by." }, "ConfigurationName": { "name": "name", "in": "path", "description": "The name that uniquely identifies a configuration.", "x-cli-description": "The name of the configuration.", "schema": { "$ref": "#/components/schemas/ConfigurationNameRO" }, "required": true, "x-linkback": "#/components/links/ConfigurationNameForGetConfiguration", "example": "configuration-name" }, "AcceptConfigurationType": { "name": "X-Sm-Accept-Configuration-Type", "in": "header", "description": "The configuration type of this configuration - use this header to resolve 300 error responses.", "x-cli-description": "The configuration type of this configuration - use this header to resolve 300 error responses.", "schema": { "$ref": "#/components/schemas/ConfigurationType" }, "example": "public_cert_configuration_dns_cloud_internet_services" }, "SecretLocksMode": { "name": "mode", "in": "query", "description": "An optional lock mode. When you create a lock, you can set one of the following modes to clear any matching locks on a secret version.\n- `remove_previous`: Removes any other locks with matching names if they are found in the previous version of the secret. - `remove_previous_and_delete`: Completes the same action as `remove_previous`, but also permanently deletes the data of the previous secret version if it doesn't have any locks. Not supported for custom credentials secret type.", "x-cli-description": "Set the lock mode. Allowable values: `remove_previous`, and `remove_previous_and_delete`. Use `remove_previous` to create a lock that clears existing locks with matching names. Use `remove_previous_and_delete` to also delete data from the previous version.", "schema": { "$ref": "#/components/schemas/SecretLocksMode" } }, "SecretLockDeleteItems": { "name": "name", "in": "query", "description": "Specify the names of the secret locks to be deleted.", "schema": { "$ref": "#/components/schemas/SecretLockDeleteItems" }, "style": "form", "explode": false, "example": [ "lock-example-1" ] }, "SecretType": { "name": "secret_type", "in": "path", "required": true, "description": "The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.", "schema": { "$ref": "#/components/schemas/SecretType" } }, "SecretName": { "name": "name", "in": "path", "required": true, "description": "A human-readable name to assign to your secret.\nTo protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", "x-cli-description": "A human-readable name to assign to your secret.\nTo protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", "schema": { "$ref": "#/components/schemas/SecretNameV1Compatible" }, "x-linkback": "#/components/links/SecretNameForGetSecretByName" } }, "schemas": { "SecretGroupPrototype": { "title": "SecretGroupPrototype", "description": "Specify a name and an optional description for your secret group.", "type": "object", "additionalProperties": false, "minProperties": 1, "maxProperties": 2, "properties": { "name": { "$ref": "#/components/schemas/SecretGroupName" }, "description": { "$ref": "#/components/schemas/SecretGroupDescription" } }, "required": [ "name" ], "example": { "name": "my-secret-group", "description": "Extended description for this group." } }, "SecretGroupPatch": { "title": "SecretGroupPatch", "description": "Update the name or description of your secret group.", "additionalProperties": false, "minProperties": 0, "maxProperties": 2, "properties": { "name": { "$ref": "#/components/schemas/SecretGroupName" }, "description": { "$ref": "#/components/schemas/SecretGroupDescription" } }, "example": { "name": "updated-secret-group-name", "description": "Updated description for this group." } }, "SecretGroup": { "title": "SecretGroup", "description": "Properties that describe a secret group.", "type": "object", "x-resource-name": "sm_secret_group", "x-terraform-resource-id": "id", "x-terraform-resource-name": "secret_group", "x-terraform-resource-operations": { "create": "create_secret_group", "read": "get_secret_group", "update": "update_secret_group", "delete": "delete_secret_group" }, "x-terraform-datasource-name": "sm_secret_group", "x-terraform-datasource-operations": { "read": "get_secret_group" }, "required": [ "id", "name", "description", "created_at", "created_by", "updated_at" ], "additionalProperties": false, "minProperties": 6, "maxProperties": 6, "properties": { "id": { "$ref": "#/components/schemas/SecretGroupId" }, "name": { "$ref": "#/components/schemas/SecretGroupNameRO" }, "description": { "$ref": "#/components/schemas/SecretGroupDescription" }, "created_at": { "$ref": "#/components/schemas/CreationDate" }, "created_by": { "$ref": "#/components/schemas/CreatedBy" }, "updated_at": { "$ref": "#/components/schemas/UpdateAt" } } }, "SecretGroupCollection": { "title": "SecretGroupCollection", "description": "Properties that describe a collection of secret groups.", "type": "object", "x-terraform-datasource-name": "sm_secret_groups", "x-terraform-datasource-operations": { "read": "list_secret_groups" }, "x-terraform-datasource-collection": "secret_groups", "required": [ "secret_groups", "total_count" ], "additionalProperties": false, "minProperties": 2, "maxProperties": 2, "properties": { "secret_groups": { "description": "A collection of secret groups.", "type": "array", "items": { "$ref": "#/components/schemas/SecretGroup" }, "minItems": 1, "maxItems": 201 }, "total_count": { "$ref": "#/components/schemas/CollectionTotalCount" } } }, "SecretPrototype": { "title": "SecretPrototype", "description": "Specify the properties for your secret.", "x-cli-description": "A JSON containing the required details for creating a secret.", "oneOf": [ { "$ref": "#/components/schemas/ArbitrarySecretPrototype" }, { "$ref": "#/components/schemas/IAMCredentialsSecretPrototype" }, { "$ref": "#/components/schemas/ImportedCertificatePrototype" }, { "$ref": "#/components/schemas/KVSecretPrototype" }, { "$ref": "#/components/schemas/PrivateCertificatePrototype" }, { "$ref": "#/components/schemas/PublicCertificatePrototype" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretPrototype" }, { "$ref": "#/components/schemas/UsernamePasswordSecretPrototype" }, { "$ref": "#/components/schemas/CustomCredentialsSecretPrototype" } ], "discriminator": { "propertyName": "secret_type", "mapping": { "arbitrary": "#/components/schemas/ArbitrarySecretPrototype", "iam_credentials": "#/components/schemas/IAMCredentialsSecretPrototype", "imported_cert": "#/components/schemas/ImportedCertificatePrototype", "kv": "#/components/schemas/KVSecretPrototype", "private_cert": "#/components/schemas/PrivateCertificatePrototype", "public_cert": "#/components/schemas/PublicCertificatePrototype", "service_credentials": "#/components/schemas/ServiceCredentialsSecretPrototype", "username_password": "#/components/schemas/UsernamePasswordSecretPrototype", "custom_credentials": "#/components/schemas/CustomCredentialsSecretPrototype" } } }, "SecretVersionPrototype": { "title": "SecretVersionPrototype", "description": "Specify the properties for your new secret version.", "anyOf": [ { "$ref": "#/components/schemas/ArbitrarySecretVersionPrototype" }, { "$ref": "#/components/schemas/IAMCredentialsSecretRestoreFromVersionPrototype" }, { "$ref": "#/components/schemas/IAMCredentialsSecretVersionPrototype" }, { "$ref": "#/components/schemas/ImportedCertificateVersionPrototype" }, { "$ref": "#/components/schemas/KVSecretVersionPrototype" }, { "$ref": "#/components/schemas/PrivateCertificateVersionPrototype" }, { "$ref": "#/components/schemas/PublicCertificateVersionPrototype" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretVersionPrototype" }, { "$ref": "#/components/schemas/UsernamePasswordSecretVersionPrototype" }, { "$ref": "#/components/schemas/CustomCredentialsSecretVersionPrototype" } ] }, "SecretMetadataPatch": { "title": "SecretMetadataPatch", "description": "Update your secret metadata.", "anyOf": [ { "$ref": "#/components/schemas/ArbitrarySecretMetadataPatch" }, { "$ref": "#/components/schemas/IAMCredentialsSecretMetadataPatch" }, { "$ref": "#/components/schemas/ImportedCertificateMetadataPatch" }, { "$ref": "#/components/schemas/KVSecretMetadataPatch" }, { "$ref": "#/components/schemas/PrivateCertificateMetadataPatch" }, { "$ref": "#/components/schemas/PublicCertificateMetadataPatch" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretMetadataPatch" }, { "$ref": "#/components/schemas/UsernamePasswordSecretMetadataPatch" }, { "$ref": "#/components/schemas/CustomCredentialsSecretMetadataPatch" } ] }, "SecretVersionMetadataPatch": { "title": "SecretVersionMetadataPatch", "description": "Update your secret version metadata.", "type": "object", "properties": { "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "ImportedCertificatePrototype": { "title": "ImportedCertificatePrototype", "x-child-schema-name": "ImportedCertificatePrototype", "type": "object", "additionalProperties": false, "required": [ "secret_type", "name" ], "properties": { "secret_type": { "$ref": "#/components/schemas/SecretType" }, "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "certificate": { "$ref": "#/components/schemas/Certificate" }, "intermediate": { "$ref": "#/components/schemas/CertificateIntermediate" }, "private_key": { "$ref": "#/components/schemas/CertificatePrivateKey" }, "managed_csr": { "$ref": "#/components/schemas/ImportedCertificateManagedCsr" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "KVSecretPrototype": { "title": "KVSecretPrototype", "x-child-schema-name": "KVSecretPrototype", "type": "object", "additionalProperties": false, "required": [ "secret_type", "name", "data" ], "properties": { "secret_type": { "$ref": "#/components/schemas/SecretType" }, "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "data": { "$ref": "#/components/schemas/KVSecretPayloadData" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "ImportedCertificateVersionPrototype": { "title": "ImportedCertificateVersionPrototype", "x-child-schema-name": "ImportedCertificateVersionPrototype", "type": "object", "additionalProperties": false, "required": [ "certificate" ], "properties": { "certificate": { "$ref": "#/components/schemas/Certificate" }, "intermediate": { "$ref": "#/components/schemas/CertificateIntermediate" }, "private_key": { "$ref": "#/components/schemas/CertificatePrivateKey" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "UsernamePasswordSecretVersionPrototype": { "title": "UsernamePasswordSecretVersionPrototype", "x-child-schema-name": "UsernamePasswordSecretVersionPrototype", "type": "object", "additionalProperties": false, "properties": { "password": { "$ref": "#/components/schemas/UserCredentialsPassword" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "ServiceCredentialsSecretVersionPrototype": { "title": "ServiceCredentialsSecretVersionPrototype", "x-child-schema-name": "ServiceCredentialsSecretVersionPrototype", "type": "object", "additionalProperties": false, "properties": { "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "CustomCredentialsSecretVersionPrototype": { "title": "CustomCredentialsSecretVersionPrototype", "x-child-schema-name": "CustomCredentialsSecretVersionPrototype", "type": "object", "additionalProperties": false, "properties": { "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "KVSecretVersionPrototype": { "title": "KVSecretVersionPrototype", "x-child-schema-name": "KVSecretVersionPrototype", "type": "object", "additionalProperties": false, "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/KVSecretPayloadData" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "ArbitrarySecretVersionPrototype": { "title": "ArbitrarySecretVersionPrototype", "x-child-schema-name": "ArbitrarySecretVersionPrototype", "type": "object", "additionalProperties": false, "required": [ "payload" ], "properties": { "payload": { "$ref": "#/components/schemas/ArbitrarySecretDataPayload" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "IAMCredentialsSecretVersionPrototype": { "title": "IAMCredentialsSecretVersionPrototype", "x-child-schema-name": "IAMCredentialsSecretVersionPrototype", "type": "object", "additionalProperties": false, "properties": { "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "IAMCredentialsSecretRestoreFromVersionPrototype": { "title": "IAMCredentialsSecretRestoreFromVersionPrototype", "x-child-schema-name": "IAMCredentialsSecretRestoreFromVersionPrototype", "type": "object", "additionalProperties": false, "required": [ "restore_from_version" ], "properties": { "restore_from_version": { "$ref": "#/components/schemas/SecretVersionId" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "ImportedCertificatePayload": { "title": "ImportedCertificatePayload", "description": "The payload of an imported certificate.", "x-child-schema-name": "ImportedCertificatePayload", "type": "object", "properties": { "certificate": { "$ref": "#/components/schemas/CertificateRO" }, "intermediate": { "$ref": "#/components/schemas/CertificateIntermediateRO" }, "private_key": { "$ref": "#/components/schemas/CertificatePrivateKeyRO" }, "csr": { "$ref": "#/components/schemas/ImportedCertificateCSR" } } }, "PublicCertificatePayload": { "title": "PublicCertificatePayload", "description": "The payload of a public certificate.", "x-child-schema-name": "PublicCertificatePayload", "type": "object", "properties": { "certificate": { "$ref": "#/components/schemas/Certificate" }, "intermediate": { "$ref": "#/components/schemas/CertificateIntermediate" }, "private_key": { "$ref": "#/components/schemas/CertificatePrivateKey" } } }, "KVSecretPayload": { "title": "KVSecretPayload", "x-child-schema-name": "KVSecretPayload", "description": "The payload of a key-value secret.", "type": "object", "x-terraform-sensitive": true, "minProperties": 1, "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/KVSecretPayloadData" } } }, "KVSecretPayloadData": { "description": "The payload data of a key-value secret.", "type": "object", "minProperties": 1, "additionalProperties": true, "x-terraform-force-new": true, "x-terraform-sensitive": true, "x-cli-option-name": "kv-data", "example": { "key": "value" } }, "IAMCredentialsSecretPayload": { "title": "IAMCredentialsSecretPayload", "x-child-schema-name": "IAMCredentialsSecretPayload", "description": "The payload of an IAM credentials secret.", "type": "object", "properties": { "api_key": { "$ref": "#/components/schemas/ApiKeyIAMCredentialsSecretRO" } } }, "UsernamePasswordSecretPayload": { "title": "UsernamePasswordSecretPayload", "description": "The payload of a user credentials secret.", "x-child-schema-name": "UsernamePasswordSecretPayload", "type": "object", "required": [ "username", "password" ], "properties": { "username": { "$ref": "#/components/schemas/UserCredentialsUsername" }, "password": { "$ref": "#/components/schemas/UserCredentialsPasswordRO" } } }, "PublicCertificatePrototype": { "title": "PublicCertificatePrototype", "x-child-schema-name": "PublicCertificatePrototype", "type": "object", "additionalProperties": false, "required": [ "secret_type", "name", "ca", "dns" ], "properties": { "secret_type": { "$ref": "#/components/schemas/SecretType" }, "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "common_name": { "$ref": "#/components/schemas/CertificateCommonName" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "key_algorithm": { "$ref": "#/components/schemas/CertificateKeyAlgorithm" }, "ca": { "$ref": "#/components/schemas/CAConfigurationName" }, "dns": { "$ref": "#/components/schemas/DNSConfigurationName" }, "bundle_certs": { "$ref": "#/components/schemas/CertificateBundleCa" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "IAMCredentialsSecretPrototype": { "title": "IAMCredentialsSecretPrototype", "x-child-schema-name": "IAMCredentialsSecretPrototype", "type": "object", "additionalProperties": false, "required": [ "secret_type", "name", "ttl", "reuse_api_key" ], "properties": { "secret_type": { "$ref": "#/components/schemas/SecretType" }, "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "ttl": { "$ref": "#/components/schemas/Ttl" }, "access_groups": { "$ref": "#/components/schemas/AccessGroupCollection" }, "service_id": { "$ref": "#/components/schemas/ServiceId" }, "account_id": { "$ref": "#/components/schemas/AccountId" }, "reuse_api_key": { "$ref": "#/components/schemas/ReuseApiKey" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "ServiceCredentialsSecretPrototype": { "title": "ServiceCredentialsSecretPrototype", "x-child-schema-name": "ServiceCredentialsSecretPrototype", "type": "object", "additionalProperties": false, "required": [ "name", "secret_type", "source_service" ], "properties": { "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "name": { "$ref": "#/components/schemas/SecretName" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "secret_type": { "$ref": "#/components/schemas/SecretType" }, "source_service": { "$ref": "#/components/schemas/ServiceCredentialsSecretSourceService" }, "ttl": { "$ref": "#/components/schemas/Ttl" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "UsernamePasswordSecretPrototype": { "title": "UsernamePasswordSecretPrototype", "x-child-schema-name": "UsernamePasswordSecretPrototype", "type": "object", "additionalProperties": false, "required": [ "secret_type", "name", "username" ], "properties": { "secret_type": { "$ref": "#/components/schemas/SecretType" }, "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "username": { "$ref": "#/components/schemas/UserCredentialsUsername" }, "password": { "$ref": "#/components/schemas/UserCredentialsPassword" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDate" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "password_generation_policy": { "$ref": "#/components/schemas/PasswordGenerationPolicy" } } }, "CustomCredentialsSecretPrototype": { "title": "CustomCredentialsSecretPrototype", "x-child-schema-name": "CustomCredentialsSecretPrototype", "type": "object", "additionalProperties": false, "required": [ "secret_type", "name", "configuration" ], "properties": { "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "name": { "$ref": "#/components/schemas/SecretName" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "secret_type": { "$ref": "#/components/schemas/SecretType" }, "ttl": { "$ref": "#/components/schemas/Ttl" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" }, "configuration": { "$ref": "#/components/schemas/CustomCredentialsConfigurationName" }, "parameters": { "$ref": "#/components/schemas/CustomCredentialsParameters" } } }, "ArbitrarySecretPrototype": { "title": "ArbitrarySecretPrototype", "x-child-schema-name": "ArbitrarySecretPrototype", "type": "object", "additionalProperties": false, "required": [ "secret_type", "name", "payload" ], "properties": { "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDate" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "name": { "$ref": "#/components/schemas/SecretName" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "secret_type": { "$ref": "#/components/schemas/SecretType" }, "payload": { "$ref": "#/components/schemas/ArbitrarySecretDataPayload" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "PublicCertificateVersionPrototype": { "title": "PublicCertificateVersionPrototype", "x-child-schema-name": "PublicCertificateVersionPrototype", "type": "object", "additionalProperties": false, "required": [ "rotation" ], "properties": { "rotation": { "$ref": "#/components/schemas/PublicCertificateRotationObject" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "PublicCertificateMetadataPatch": { "title": "PublicCertificateMetadataPatch", "x-child-schema-name": "PublicCertificateMetadataPatch", "type": "object", "additionalProperties": false, "properties": { "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" } } }, "ArbitrarySecretMetadataPatch": { "title": "ArbitrarySecretMetadataPatch", "x-child-schema-name": "ArbitrarySecretMetadataPatch", "type": "object", "additionalProperties": false, "properties": { "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDate" } } }, "ImportedCertificateMetadataPatch": { "title": "ImportedCertificateMetadataPatch", "x-child-schema-name": "ImportedCertificateMetadataPatch", "type": "object", "additionalProperties": false, "properties": { "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "managed_csr": { "$ref": "#/components/schemas/ImportedCertificateManagedCsr" } } }, "KVSecretMetadataPatch": { "title": "KVSecretMetadataPatch", "x-child-schema-name": "KVSecretMetadataPatch", "type": "object", "additionalProperties": false, "properties": { "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" } } }, "UsernamePasswordSecretMetadataPatch": { "title": "UsernamePasswordSecretMetadataPatch", "x-child-schema-name": "UsernamePasswordSecretMetadataPatch", "type": "object", "additionalProperties": false, "properties": { "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDate" }, "password_generation_policy": { "$ref": "#/components/schemas/PasswordGenerationPolicyPatch" } } }, "ServiceCredentialsSecretMetadataPatch": { "title": "ServiceCredentialsSecretMetadataPatch", "x-child-schema-name": "ServiceCredentialsSecretMetadataPatch", "type": "object", "additionalProperties": false, "properties": { "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "name": { "$ref": "#/components/schemas/SecretName" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "ttl": { "$ref": "#/components/schemas/Ttl" } } }, "CustomCredentialsSecretMetadataPatch": { "title": "CustomCredentialsSecretMetadataPatch", "x-child-schema-name": "CustomCredentialsSecretMetadataPatch", "type": "object", "additionalProperties": false, "properties": { "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "name": { "$ref": "#/components/schemas/SecretName" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "ttl": { "$ref": "#/components/schemas/Ttl" }, "parameters": { "$ref": "#/components/schemas/CustomCredentialsParameters" } } }, "SecretActionPrototype": { "title": "SecretActionPrototype", "description": "The request body to specify the properties for your secret action.", "anyOf": [ { "$ref": "#/components/schemas/PrivateCertificateActionRevokePrototype" }, { "$ref": "#/components/schemas/PublicCertificateActionValidateManualDNSPrototype" } ], "discriminator": { "propertyName": "action_type", "mapping": { "public_cert_action_validate_dns_challenge": "#/components/schemas/PublicCertificateActionValidateManualDNSPrototype", "private_cert_action_revoke_certificate": "#/components/schemas/PrivateCertificateActionRevokePrototype" } } }, "PublicCertificateActionValidateManualDNSPrototype": { "title": "PublicCertificateActionValidateManualDNSPrototype", "x-child-schema-name": "PublicCertificateActionValidateManualDNSPrototype", "description": "The request body to specify the properties of the action to validate manual DNS challenges for the public certificate.", "type": "object", "additionalProperties": false, "required": [ "action_type" ], "properties": { "action_type": { "$ref": "#/components/schemas/SecretActionType" } } }, "SecretAction": { "title": "SecretAction", "description": "The response body to specify the properties of the action to create a secret.", "anyOf": [ { "$ref": "#/components/schemas/PublicCertificateActionValidateManualDNS" }, { "$ref": "#/components/schemas/PrivateCertificateActionRevoke" } ], "discriminator": { "propertyName": "action_type", "mapping": { "private_cert_action_revoke_certificate": "#/components/schemas/PrivateCertificateActionRevoke", "public_cert_action_validate_dns_challenge": "#/components/schemas/PublicCertificateActionValidateManualDNS" } } }, "SecretVersionActionPrototype": { "title": "SecretVersionActionPrototype", "description": "The request body to specify the properties of the action to create a secret version.", "anyOf": [ { "$ref": "#/components/schemas/PrivateCertificateVersionActionRevokePrototype" } ], "discriminator": { "propertyName": "action_type", "mapping": { "private_cert_action_revoke_certificate": "#/components/schemas/PrivateCertificateVersionActionRevokePrototype" } } }, "VersionAction": { "title": "VersionAction", "description": "The request body to specify the properties of the action to create a secret version.", "x-terraform-datasource-name": "sm_secret_version_action", "x-terraform-datasource-operations": { "read": "create_secret_version_action" }, "anyOf": [ { "$ref": "#/components/schemas/PrivateCertificateVersionActionRevoke" } ], "discriminator": { "propertyName": "action_type", "mapping": { "private_cert_action_revoke_certificate": "#/components/schemas/PrivateCertificateVersionActionRevoke" } } }, "ConfigurationActionPrototype": { "title": "ConfigurationActionPrototype", "description": "The request body to specify the properties of the action to create a configuration.", "anyOf": [ { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionRotateCRLPrototype" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionRevokePrototype" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionRotatePrototype" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionSignCSRPrototype" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionSignIntermediatePrototype" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionSetSignedPrototype" } ], "discriminator": { "propertyName": "action_type", "mapping": { "private_cert_configuration_action_rotate_crl": "#/components/schemas/PrivateCertificateConfigurationActionRotateCRLPrototype", "private_cert_configuration_action_revoke_ca_certificate": "#/components/schemas/PrivateCertificateConfigurationActionRevokePrototype", "private_cert_configuration_action_rotate_intermediate": "#/components/schemas/PrivateCertificateConfigurationActionRotatePrototype", "private_cert_configuration_action_sign_csr": "#/components/schemas/PrivateCertificateConfigurationActionSignCSRPrototype", "private_cert_configuration_action_sign_intermediate": "#/components/schemas/PrivateCertificateConfigurationActionSignIntermediatePrototype", "private_cert_configuration_action_set_signed": "#/components/schemas/PrivateCertificateConfigurationActionSetSignedPrototype" } } }, "ConfigurationAction": { "title": "ConfigurationAction", "description": "The response body to specify the properties of the action to create a configuration.", "anyOf": [ { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionRevoke" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionRotate" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionSignCSR" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionSignIntermediate" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionSetSigned" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionRotateCRL" } ], "discriminator": { "propertyName": "action_type", "mapping": { "private_cert_configuration_action_revoke_ca_certificate": "#/components/schemas/PrivateCertificateConfigurationActionRevoke", "private_cert_configuration_action_rotate_intermediate": "#/components/schemas/PrivateCertificateConfigurationActionRotate", "private_cert_configuration_action_sign_csr": "#/components/schemas/PrivateCertificateConfigurationActionSignCSR", "private_cert_configuration_action_sign_intermediate": "#/components/schemas/PrivateCertificateConfigurationActionSignIntermediate", "private_cert_configuration_action_set_signed": "#/components/schemas/PrivateCertificateConfigurationActionSetSigned", "private_cert_configuration_action_rotate_crl": "#/components/schemas/PrivateCertificateConfigurationActionRotateCRL" } } }, "PublicCertificateActionValidateManualDNS": { "title": "PublicCertificateActionValidateManualDNS", "x-child-schema-name": "PublicCertificateActionValidateManualDNS", "description": "The response body of the action to validate manual DNS challenges for the public certificate.", "x-terraform-datasource-name": "sm_public_certificate_action_validate_manual_dns", "x-terraform-datasource-operations": { "read": "create_secret_action" }, "type": "object", "additionalProperties": false, "required": [ "action_type" ], "properties": { "action_type": { "$ref": "#/components/schemas/SecretActionType" } } }, "PrivateCertificateActionRevoke": { "title": "PrivateCertificateActionRevoke", "x-child-schema-name": "PrivateCertificateActionRevoke", "description": "The response body of the action to revoke the private certificate.", "x-terraform-datasource-name": "sm_private_certificate_action_revoke", "x-terraform-datasource-operations": { "read": "create_secret_action" }, "type": "object", "additionalProperties": false, "required": [ "action_type", "revocation_time_seconds" ], "properties": { "action_type": { "$ref": "#/components/schemas/SecretActionType" }, "revocation_time_seconds": { "$ref": "#/components/schemas/PrivateCertificateRevocationTime" } } }, "PrivateCertificateActionRevokePrototype": { "title": "PrivateCertificateActionRevokePrototype", "x-child-schema-name": "PrivateCertificateActionRevokePrototype", "description": "The request body to specify the properties of the action to revoke the private certificate.", "type": "object", "additionalProperties": false, "required": [ "action_type" ], "properties": { "action_type": { "$ref": "#/components/schemas/SecretActionType" } } }, "PrivateCertificateVersionActionRevoke": { "title": "PrivateCertificateVersionActionRevoke", "x-child-schema-name": "PrivateCertificateVersionActionRevoke", "description": "The response body to specify the properties of the action to revoke the private certificate.", "type": "object", "additionalProperties": false, "required": [ "action_type", "revocation_time_seconds" ], "properties": { "action_type": { "$ref": "#/components/schemas/SecretVersionActionType" }, "revocation_time_seconds": { "$ref": "#/components/schemas/PrivateCertificateRevocationTime" } } }, "PrivateCertificateVersionActionRevokePrototype": { "title": "PrivateCertificateVersionActionRevokePrototype", "x-child-schema-name": "PrivateCertificateVersionActionRevokePrototype", "description": "The request body to specify the properties of the action to revoke the private certificate.", "type": "object", "additionalProperties": false, "required": [ "action_type" ], "properties": { "action_type": { "$ref": "#/components/schemas/SecretVersionActionType" } } }, "PrivateCertificateConfigurationActionRevoke": { "title": "PrivateCertificateConfigurationActionRevoke", "x-child-schema-name": "PrivateCertificateConfigurationActionRevoke", "description": "The response body to specify the properties of the action to revoke the private certificate.", "type": "object", "additionalProperties": false, "required": [ "action_type", "revocation_time_seconds" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" }, "revocation_time_seconds": { "$ref": "#/components/schemas/PrivateCertificateRevocationTime" } } }, "PrivateCertificateConfigurationActionRevokePrototype": { "title": "PrivateCertificateConfigurationActionRevokePrototype", "x-child-schema-name": "PrivateCertificateConfigurationActionRevokePrototype", "description": "The request body to specify the properties of the action to revoke the private certificate configuration.", "type": "object", "additionalProperties": false, "required": [ "action_type" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" } } }, "PrivateCertificateConfigurationActionSignCSR": { "title": "PrivateCertificateConfigurationActionSignCSR", "x-child-schema-name": "PrivateCertificateConfigurationActionSignCSR", "description": "The response body of the action to sign the CSR for the private certificate configuration.", "x-terraform-datasource-name": "sm_private_certificate_configuration_action_sign_csr", "x-terraform-datasource-operations": { "read": "create_configuration_action" }, "allOf": [ { "$ref": "#/components/schemas/PrivateCertificateConfigurationSignAction" }, { "type": "object", "required": [ "action_type", "csr", "data" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" }, "csr": { "$ref": "#/components/schemas/PrivateCertificateCSR" }, "data": { "$ref": "#/components/schemas/PrivateCertificateConfigurationCACertificate" } } } ] }, "PrivateCertificateConfigurationActionRotatePrototype": { "title": "PrivateCertificateConfigurationActionRotatePrototype", "x-child-schema-name": "PrivateCertificateConfigurationActionRotatePrototype", "description": "The request body to specify the properties of the action to rotate an intermediate CA certificate.", "type": "object", "additionalProperties": false, "required": [ "action_type" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" } } }, "PrivateCertificateConfigurationActionRotate": { "title": "PrivateCertificateConfigurationActionRotate", "x-child-schema-name": "PrivateCertificateConfigurationActionRotate", "description": "The response body to specify the properties of the action to rotate the private certificate.", "allOf": [ { "type": "object", "required": [ "action_type", "name", "config" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" }, "name": { "$ref": "#/components/schemas/IntermediateCANameRO" }, "config": { "$ref": "#/components/schemas/PrivateCertificateConfigurationRotateAction" } } } ] }, "PrivateCertificateConfigurationRotateAction": { "title": "PrivateCertificateConfigurationRotateAction", "x-child-schema-name": "PrivateCertificateConfigurationRotateAction", "type": "object", "description": "The response body of the action to rotate an intermediate certificate authority for the private certificate configuration.", "properties": { "common_name": { "$ref": "#/components/schemas/PrivateCertificateCommonName" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "ip_sans": { "$ref": "#/components/schemas/PrivateCertificateIpSans" }, "uri_sans": { "$ref": "#/components/schemas/PrivateCertificateUriSans" }, "other_sans": { "$ref": "#/components/schemas/PrivateCertificateOtherSans" }, "ttl": { "$ref": "#/components/schemas/PrivateCertificateTemplateTTLSeconds" }, "format": { "$ref": "#/components/schemas/PrivateCertificateFormat" }, "max_path_length": { "$ref": "#/components/schemas/PrivateCertificateMaxPathLength" }, "exclude_cn_from_sans": { "$ref": "#/components/schemas/PrivateCertificateExcludeCnFromSans" }, "permitted_dns_domains": { "$ref": "#/components/schemas/PrivateCertificatePermittedDnsDomains" }, "use_csr_values": { "$ref": "#/components/schemas/PrivateCertificateUseCsrValues" }, "ou": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganizationalUnit" }, "organization": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganization" }, "country": { "$ref": "#/components/schemas/PrivateCertificateSubjectCountry" }, "locality": { "$ref": "#/components/schemas/PrivateCertificateSubjectLocality" }, "province": { "$ref": "#/components/schemas/PrivateCertificateSubjectProvince" }, "street_address": { "$ref": "#/components/schemas/PrivateCertificateSubjectStreetAddress" }, "postal_code": { "$ref": "#/components/schemas/PrivateCertificateSubjectPostalCode" }, "serial_number": { "$ref": "#/components/schemas/PrivateCertificateRequestedSerialNumber" }, "csr": { "$ref": "#/components/schemas/PrivateCertificateCSR" }, "data": { "$ref": "#/components/schemas/PrivateCertificateConfigurationCACertificate" } } }, "PrivateCertificateConfigurationActionSignCSRPrototype": { "title": "PrivateCertificateConfigurationActionSignCSRPrototype", "x-child-schema-name": "PrivateCertificateConfigurationActionSignCSRPrototype", "description": "The request body to specify the properties of the action to sign a CSR for the private certificate configuration.", "allOf": [ { "$ref": "#/components/schemas/PrivateCertificateConfigurationSignAction" }, { "type": "object", "required": [ "action_type", "csr" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" }, "csr": { "$ref": "#/components/schemas/PrivateCertificateCSR" } } } ] }, "PrivateCertificateConfigurationActionSignIntermediate": { "title": "PrivateCertificateConfigurationActionSignIntermediate", "x-child-schema-name": "PrivateCertificateConfigurationActionSignIntermediate", "description": "The response body of the action to sign the intermediate certificate authority for the private certificate configuration.", "allOf": [ { "$ref": "#/components/schemas/PrivateCertificateConfigurationSignAction" }, { "type": "object", "required": [ "action_type", "intermediate_certificate_authority" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" }, "intermediate_certificate_authority": { "$ref": "#/components/schemas/IntermediateCANameRO" } } } ] }, "PrivateCertificateConfigurationActionSignIntermediatePrototype": { "title": "PrivateCertificateConfigurationActionSignIntermediatePrototype", "x-child-schema-name": "PrivateCertificateConfigurationActionSignIntermediatePrototype", "description": "The request body to specify the properties of the action to sign an intermediate certificate authority for the private certificate configuration.", "allOf": [ { "$ref": "#/components/schemas/PrivateCertificateConfigurationSignAction" }, { "type": "object", "required": [ "action_type", "intermediate_certificate_authority" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" }, "intermediate_certificate_authority": { "$ref": "#/components/schemas/IntermediateCANameRO" } } } ] }, "PrivateCertificateConfigurationActionSetSigned": { "title": "PrivateCertificateConfigurationActionSetSigned", "x-child-schema-name": "PrivateCertificateConfigurationActionSetSigned", "description": "The response body of the action to set a signed intermediate certificate authority for the private certificate configuration.", "type": "object", "required": [ "action_type", "certificate" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" }, "certificate": { "$ref": "#/components/schemas/Certificate" } } }, "PrivateCertificateConfigurationActionSetSignedPrototype": { "title": "PrivateCertificateConfigurationActionSetSignedPrototype", "x-child-schema-name": "PrivateCertificateConfigurationActionSetSignedPrototype", "description": "The request body of the action to set a signed intermediate certificate authority for the private certificate consideration.", "additionalProperties": false, "required": [ "action_type", "certificate" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" }, "certificate": { "$ref": "#/components/schemas/Certificate" } } }, "PrivateCertificateConfigurationActionRotateCRL": { "title": "PrivateCertificateConfigurationActionRotateCRL", "x-child-schema-name": "PrivateCertificateConfigurationActionRotateCRL", "description": "The response body of the action to rotate the CRL of an intermediate certificate authority for the private certificate configuration.", "type": "object", "required": [ "action_type", "success" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" }, "success": { "$ref": "#/components/schemas/PrivateCertificateConfigurationActionRotateCRLSuccess" } } }, "PrivateCertificateConfigurationActionRotateCRLSuccess": { "title": "PrivateCertificateConfigurationActionRotateCRLData", "description": "This field indicates whether the request to rotate the CRL for the private certificate configuration was successful.", "type": "boolean" }, "PrivateCertificateConfigurationActionRotateCRLPrototype": { "title": "PrivateCertificateConfigurationActionRotateCRLPrototype", "x-child-schema-name": "PrivateCertificateConfigurationActionRotateCRLPrototype", "description": "The request body of the action to rotate the CRL of an intermediate certificate authority for the private certificate configuration.", "additionalProperties": false, "required": [ "action_type" ], "properties": { "action_type": { "$ref": "#/components/schemas/ConfigurationActionType" } } }, "PrivateCertificateConfigurationSignAction": { "type": "object", "description": "The request body of the action to sign an intermediate certificate authority with an internal certificate authority for the private certificate configuration.", "properties": { "common_name": { "$ref": "#/components/schemas/PrivateCertificateCommonName" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "ip_sans": { "$ref": "#/components/schemas/PrivateCertificateIpSans" }, "uri_sans": { "$ref": "#/components/schemas/PrivateCertificateUriSans" }, "other_sans": { "$ref": "#/components/schemas/PrivateCertificateOtherSans" }, "ttl": { "$ref": "#/components/schemas/PrivateCertificateTTL" }, "format": { "$ref": "#/components/schemas/PrivateCertificateFormat" }, "max_path_length": { "$ref": "#/components/schemas/PrivateCertificateMaxPathLength" }, "exclude_cn_from_sans": { "$ref": "#/components/schemas/PrivateCertificateExcludeCnFromSans" }, "permitted_dns_domains": { "$ref": "#/components/schemas/PrivateCertificatePermittedDnsDomains" }, "use_csr_values": { "$ref": "#/components/schemas/PrivateCertificateUseCsrValues" }, "ou": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganizationalUnit" }, "organization": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganization" }, "country": { "$ref": "#/components/schemas/PrivateCertificateSubjectCountry" }, "locality": { "$ref": "#/components/schemas/PrivateCertificateSubjectLocality" }, "province": { "$ref": "#/components/schemas/PrivateCertificateSubjectProvince" }, "street_address": { "$ref": "#/components/schemas/PrivateCertificateSubjectStreetAddress" }, "postal_code": { "$ref": "#/components/schemas/PrivateCertificateSubjectPostalCode" }, "serial_number": { "$ref": "#/components/schemas/PrivateCertificateRequestedSerialNumber" } } }, "CommonSecretMetadata": { "title": "CommonSecretMetadata", "x-child-schema-name": "CommonSecretMetadata", "type": "object", "required": [ "created_by", "created_at", "crn", "downloaded", "id", "locks_total", "name", "secret_group_id", "secret_type", "state", "state_description", "updated_at", "versions_total" ], "properties": { "created_by": { "$ref": "#/components/schemas/CreatedBy" }, "created_at": { "$ref": "#/components/schemas/CreationDate" }, "retrieved_at": { "$ref": "#/components/schemas/RetrievalDate" }, "crn": { "$ref": "#/components/schemas/ResourceCrn" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "downloaded": { "$ref": "#/components/schemas/SecretVersionDownloaded" }, "id": { "$ref": "#/components/schemas/Uuid" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "locks_total": { "$ref": "#/components/schemas/SecretLocksTotal" }, "name": { "$ref": "#/components/schemas/SecretNameRO" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "secret_type": { "$ref": "#/components/schemas/SecretType" }, "state": { "$ref": "#/components/schemas/SecretState" }, "state_description": { "$ref": "#/components/schemas/SecretStateDescription" }, "updated_at": { "$ref": "#/components/schemas/UpdateAt" }, "versions_total": { "$ref": "#/components/schemas/SecretVersionsTotal" }, "referenced_by": { "$ref": "#/components/schemas/ReferencedBy" } } }, "CommonSecretVersionMetadata": { "title": "CommonSecretVersionMetadata", "x-child-schema-name": "CommonSecretVersionMetadata", "type": "object", "required": [ "created_by", "created_at", "id", "secret_name", "secret_group_id", "secret_type", "secret_id", "payload_available" ], "properties": { "auto_rotated": { "$ref": "#/components/schemas/AutoRotated" }, "created_by": { "$ref": "#/components/schemas/CreatedBy" }, "created_at": { "$ref": "#/components/schemas/CreationDate" }, "downloaded": { "$ref": "#/components/schemas/SecretVersionDownloaded" }, "id": { "$ref": "#/components/schemas/Uuid" }, "secret_name": { "$ref": "#/components/schemas/SecretNameRO" }, "secret_type": { "$ref": "#/components/schemas/SecretType" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "payload_available": { "$ref": "#/components/schemas/SecretVersionPayloadAvailable" }, "alias": { "$ref": "#/components/schemas/SecretVersionAlias" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" }, "secret_id": { "$ref": "#/components/schemas/Uuid" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" } } }, "SecretMetadataPaginatedCollection": { "title": "SecretMetadataPaginatedCollection", "description": "Properties that describe a paginated collection of your secret metadata.", "x-terraform-datasource-name": "sm_secrets", "x-terraform-datasource-operations": { "read": "list_secrets" }, "x-terraform-datasource-collection": "secrets", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "$ref": "#/components/schemas/SecretMetadataCollection" } ] }, "SecretTaskCollection": { "title": "SecretTaskCollection", "description": "A collection of tasks that are associated with a secret.", "x-terraform-datasource-name": "sm_secret_tasks", "x-terraform-datasource-operations": { "read": "list_secret_tasks" }, "x-terraform-datasource-collection": "secret_tasks", "allOf": [ { "$ref": "#/components/schemas/SecretTasks" } ] }, "SecretTasks": { "title": "SecretTasks", "description": "Properties that describe a collection of your secret's tasks.", "type": "object", "required": [ "tasks" ], "properties": { "tasks": { "description": "A collection of secret metadata.", "type": "array", "items": { "$ref": "#/components/schemas/SecretTask" }, "minItems": 0, "maxItems": 1000 } } }, "SecretTask": { "title": "SecretTask", "x-child-schema-name": "SecretTask", "description": "Properties of a Secret's task.", "type": "object", "required": [ "id", "creation_date", "created_by", "last_update_date", "updated_by", "type", "status", "trigger", "secret_id" ], "properties": { "id": { "$ref": "#/components/schemas/TaskId" }, "created_by": { "$ref": "#/components/schemas/CreatedBy" }, "creation_date": { "$ref": "#/components/schemas/CreationDate" }, "last_update_date": { "$ref": "#/components/schemas/UpdateAt" }, "updated_by": { "$ref": "#/components/schemas/UpdatedBy" }, "type": { "$ref": "#/components/schemas/TaskType" }, "status": { "$ref": "#/components/schemas/TaskStatus" }, "trigger": { "$ref": "#/components/schemas/TaskTrigger" }, "secret_id": { "$ref": "#/components/schemas/Uuid" }, "secret_version_id": { "$ref": "#/components/schemas/Uuid" }, "errors": { "$ref": "#/components/schemas/SecretTaskErrorCollection" } } }, "TaskTrigger": { "title": "TaskTrigger", "description": "Information about what has initiated the task.", "type": "string", "enum": [ "secret_creation", "manual_secret_rotation", "automatic_secret_rotation", "secret_version_expiration", "secret_version_data_deletion" ] }, "TaskType": { "title": "SecretType", "description": "The type of the task, can be either \"create_credentials\" or \"delete_credentials\"", "x-cli-option-name": "task-type", "x-cli-description": "The task type.", "type": "string", "enum": [ "create_credentials", "delete_credentials" ] }, "TaskStatus": { "title": "TaskStatus", "description": "The status of a task, could be one of: queued, processing, succeeded, failed.", "x-cli-option-name": "task-status", "x-cli-description": "The task status.", "type": "string", "enum": [ "queued", "processing", "credentials_created", "credentials_deleted", "failed" ] }, "TaskId": { "title": "TaskId", "description": "A Secret Manager task identifier.", "type": "string", "pattern": "^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 44, "maxLength": 44, "example": "sm-task-b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5" }, "SecretTaskPrototype": { "title": "SecretTaskPrototype", "description": "The request body to specify the properties for your secret task update.", "oneOf": [ { "$ref": "#/components/schemas/UpdateSecretTaskCredentialsCreated" }, { "$ref": "#/components/schemas/UpdateSecretTaskCredentialsDeleted" }, { "$ref": "#/components/schemas/UpdateSecretTaskFailed" } ], "discriminator": { "propertyName": "status", "mapping": { "credentials_created": "#/components/schemas/UpdateSecretTaskCredentialsCreated", "credentials_deleted": "#/components/schemas/UpdateSecretTaskCredentialsDeleted", "failed": "#/components/schemas/UpdateSecretTaskFailed" } } }, "UpdateSecretTaskCredentialsCreated": { "title": "UpdateSecretTaskCredentialsCreated", "description": "Called by the credentials provider on a successful creation of credentials.", "x-terraform-sensitive": true, "type": "object", "additionalProperties": false, "required": [ "status", "credentials" ], "properties": { "status": { "description": "Describes the status of a secret's task", "type": "string", "enum": [ "credentials_created" ] }, "credentials": { "$ref": "#/components/schemas/CustomCredentialsNewCredentials" } } }, "UpdateSecretTaskCredentialsDeleted": { "title": "UpdateSecretTaskCredentialsDeleted", "description": "This endpoint is called back by the credentials provider on a successful deletion of credentials.", "x-terraform-sensitive": true, "type": "object", "additionalProperties": false, "required": [ "status" ], "properties": { "status": { "description": "Describes the status of a secret's task", "type": "string", "enum": [ "credentials_deleted" ] } } }, "UpdateSecretTaskFailed": { "title": "UpdateSecretTaskFailed", "description": "Flag task as failed upon failure to create or delete credentials.", "x-terraform-sensitive": true, "type": "object", "additionalProperties": false, "required": [ "status", "errors" ], "properties": { "status": { "description": "Describes the status of a secret's task", "type": "string", "enum": [ "failed" ] }, "errors": { "description": "A collection of errors.", "type": "array", "items": { "$ref": "#/components/schemas/SecretTaskError" }, "minItems": 1, "maxItems": 10 } } }, "CustomCredentialsNewCredentials": { "title": "CustomCredentialsNewCredentials", "description": "Newly created credentials provided by the credentials provider.", "x-terraform-sensitive": true, "type": "object", "additionalProperties": false, "required": [ "id", "payload" ], "properties": { "id": { "$ref": "#/components/schemas/CustomCredentialsCredentialsSystemId" }, "payload": { "$ref": "#/components/schemas/CustomCredentialsFields" } } }, "CustomCredentialsCredentialsSystemId": { "title": "CustomCredentialsCredentialsSystemId", "description": "An identifier of credentials in the credentials provider that is used by the custom credentials secret type.", "type": "string", "pattern": "^(.*?)$", "minLength": 2, "maxLength": 1024, "example": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5" }, "SecretTaskError": { "title": "SecretTaskError", "description": "API Error", "type": "object", "additionalProperties": false, "required": [ "code", "description" ], "properties": { "code": { "description": "An error code identifier.", "type": "string", "pattern": "^(.*?)$", "minLength": 1, "maxLength": 32 }, "description": { "description": "A human-readable message that provides details about the error.", "type": "string", "pattern": "^(.*?)$", "minLength": 1, "maxLength": 1024, "example": "Failed to create credentials" } } }, "SecretTaskErrorCollection": { "title": "SecretTaskErrorCollection", "type": "array", "description": "A collection of errors.", "minItems": 0, "maxItems": 10, "items": { "$ref": "#/components/schemas/SecretTaskError" } }, "SecretLocksPaginatedCollection": { "title": "SecretLocksPaginatedCollection", "description": "Properties that describe a paginated collection of your secret locks.", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "$ref": "#/components/schemas/SecretLockCollection" } ] }, "SecretsLocksPaginatedCollection": { "title": "SecretsLocksPaginatedCollection", "description": "Properties that describe a paginated collection of your secrets locks.", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "$ref": "#/components/schemas/SecretsLockCollection" } ] }, "SecretVersionLocksPaginatedCollection": { "title": "SecretLocksPaginatedCollection", "description": "Properties that describe a paginated collection of your secret version locks.", "x-resource-name": "sm_secret_version_locks", "x-terraform-resource-name": "secret_version_locks", "x-terraform-resource-id": "locks", "x-terraform-resource-operations": { "create": "create_secret_version_locks", "read": "list_secret_version_locks", "delete": "delete_secret_version_locks" }, "x-terraform-datasource-name": "sm_secret_version_locks", "x-terraform-datasource-operations": { "read": "list_secret_version_locks" }, "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "$ref": "#/components/schemas/SecretVersionLocksCollection" } ] }, "SecretMetadataCollection": { "title": "SecretMetadataCollection", "description": "Properties that describe a collection of your secret metadata.", "type": "object", "required": [ "secrets" ], "properties": { "secrets": { "description": "A collection of secret metadata.", "type": "array", "items": { "$ref": "#/components/schemas/SecretMetadata" }, "minItems": 0, "maxItems": 1000 } } }, "SecretMetadata": { "title": "SecretMetadata", "description": "Properties of your secret metadata.", "anyOf": [ { "$ref": "#/components/schemas/ArbitrarySecretMetadata" }, { "$ref": "#/components/schemas/IAMCredentialsSecretMetadata" }, { "$ref": "#/components/schemas/ImportedCertificateMetadata" }, { "$ref": "#/components/schemas/KVSecretMetadata" }, { "$ref": "#/components/schemas/PrivateCertificateMetadata" }, { "$ref": "#/components/schemas/PublicCertificateMetadata" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretMetadata" }, { "$ref": "#/components/schemas/UsernamePasswordSecretMetadata" }, { "$ref": "#/components/schemas/CustomCredentialsSecretMetadata" } ], "discriminator": { "propertyName": "secret_type", "mapping": { "arbitrary": "#/components/schemas/ArbitrarySecretMetadata", "iam_credentials": "#/components/schemas/IAMCredentialsSecretMetadata", "imported_cert": "#/components/schemas/ImportedCertificateMetadata", "kv": "#/components/schemas/KVSecretMetadata", "private_cert": "#/components/schemas/PrivateCertificateMetadata", "public_cert": "#/components/schemas/PublicCertificateMetadata", "service_credentials": "#/components/schemas/ServiceCredentialsSecretMetadata", "username_password": "#/components/schemas/UsernamePasswordSecretMetadata", "custom_credentials": "#/components/schemas/CustomCredentialsSecretMetadata" } } }, "SecretVersionMetadataCollection": { "title": "SecretVersionMetadataCollection", "description": "Properties that describe a collection of your secret version metadata.", "type": "object", "x-terraform-datasource-name": "sm_secret_versions", "x-terraform-datasource-operations": { "read": "list_secret_versions" }, "x-terraform-datasource-collection": "versions", "required": [ "versions", "total_count" ], "additionalProperties": false, "minProperties": 2, "maxProperties": 2, "properties": { "versions": { "description": "A collection of secret version metadata.", "type": "array", "items": { "$ref": "#/components/schemas/SecretVersionMetadata" }, "minItems": 0, "maxItems": 50 }, "total_count": { "$ref": "#/components/schemas/CollectionTotalCount" } } }, "SecretVersionMetadata": { "title": "SecretVersionMetadata", "description": "Properties of the version metadata of your secret.", "x-terraform-datasource-name": "sm_secret_version_metadata", "x-terraform-datasource-operations": { "read": "get_secret_version_metadata" }, "anyOf": [ { "$ref": "#/components/schemas/ArbitrarySecretVersionMetadata" }, { "$ref": "#/components/schemas/IAMCredentialsSecretVersionMetadata" }, { "$ref": "#/components/schemas/ImportedCertificateVersionMetadata" }, { "$ref": "#/components/schemas/KVSecretVersionMetadata" }, { "$ref": "#/components/schemas/PrivateCertificateVersionMetadata" }, { "$ref": "#/components/schemas/PublicCertificateVersionMetadata" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretVersionMetadata" }, { "$ref": "#/components/schemas/UsernamePasswordSecretVersionMetadata" }, { "$ref": "#/components/schemas/CustomCredentialsSecretVersionMetadata" } ], "discriminator": { "propertyName": "secret_type", "mapping": { "arbitrary": "#/components/schemas/ArbitrarySecretVersionMetadata", "iam_credentials": "#/components/schemas/IAMCredentialsSecretVersionMetadata", "imported_cert": "#/components/schemas/ImportedCertificateVersionMetadata", "kv": "#/components/schemas/KVSecretVersionMetadata", "private_cert": "#/components/schemas/PrivateCertificateVersionMetadata", "public_cert": "#/components/schemas/PublicCertificateVersionMetadata", "service_credentials": "#/components/schemas/ServiceCredentialsSecretVersionMetadata", "username_password": "#/components/schemas/UsernamePasswordSecretVersionMetadata", "custom_credentials": "#/components/schemas/CustomCredentialsSecretVersionMetadata" } } }, "ImportedCertificateMetadata": { "title": "ImportedCertificateMetadata", "x-child-schema-name": "ImportedCertificateMetadata", "description": "Properties of the secret metadata of your imported certificate.", "x-terraform-datasource-name": "sm_imported_certificate_metadata", "x-terraform-datasource-operations": { "read": "get_secret_metadata" }, "allOf": [ { "$ref": "#/components/schemas/CommonSecretMetadata" }, { "$ref": "#/components/schemas/ImportedCertificateConcreteMetadata" } ] }, "ImportedCertificateConcreteMetadata": { "title": "ImportedCertificateConcreteMetadata", "x-child-schema-name": "ImportedCertificateConcreteMetadata", "description": "Properties of the concrete metadata of your imported certificate.", "type": "object", "properties": { "signing_algorithm": { "$ref": "#/components/schemas/CertificateSigningAlgorithm" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "common_name": { "$ref": "#/components/schemas/CertificateCommonName" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" }, "intermediate_included": { "$ref": "#/components/schemas/CertificateIntermediateIncluded" }, "issuer": { "$ref": "#/components/schemas/CertificateIssuer" }, "key_algorithm": { "$ref": "#/components/schemas/CertificateKeyAlgorithmRO" }, "private_key_included": { "$ref": "#/components/schemas/CertificatePrivateKeyIncluded" }, "serial_number": { "$ref": "#/components/schemas/CertificateSerialNumber" }, "validity": { "$ref": "#/components/schemas/CertificateValidity" }, "managed_csr": { "$ref": "#/components/schemas/ImportedCertificateManagedCsrResponse" } } }, "ImportedCertificateVersionMetadata": { "title": "ImportedCertificateVersionMetadata", "x-child-schema-name": "ImportedCertificateVersionMetadata", "description": "Properties of the version metadata of your imported certificate.", "allOf": [ { "$ref": "#/components/schemas/CommonSecretVersionMetadata" }, { "$ref": "#/components/schemas/ImportedCertificateVersionConcreteMetadata" } ] }, "ImportedCertificateVersionConcreteMetadata": { "title": "ImportedCertificateVersionConcreteMetadata", "x-child-schema-name": "ImportedCertificateVersionConcreteMetadata", "description": "Properties of the concrete metadata of your imported certificate version.", "type": "object", "required": [ "serial_number", "validity" ], "properties": { "serial_number": { "$ref": "#/components/schemas/CertificateSerialNumber" }, "validity": { "$ref": "#/components/schemas/CertificateValidity" } } }, "PublicCertificateMetadata": { "title": "PublicCertificateMetadata", "x-child-schema-name": "PublicCertificateMetadata", "description": "Properties of the metadata of your public certificate.", "x-terraform-datasource-name": "sm_public_certificate_metadata", "x-terraform-datasource-operations": { "read": "get_secret_metadata" }, "allOf": [ { "$ref": "#/components/schemas/CommonSecretMetadata" }, { "$ref": "#/components/schemas/PublicCertificateConcreteMetadata" } ] }, "KVSecretMetadata": { "title": "KVSecretMetadata", "x-child-schema-name": "KVSecretMetadata", "description": "Properties of the metadata of your key-value secret metadata.", "x-terraform-datasource-name": "sm_kv_secret_metadata", "x-terraform-datasource-operations": { "read": "get_secret_metadata" }, "allOf": [ { "$ref": "#/components/schemas/CommonSecretMetadata" } ] }, "PublicCertificateConcreteMetadata": { "title": "PublicCertificateConcreteMetadata", "x-child-schema-name": "PublicCertificateConcreteMetadata", "description": "Properties of the concrete metadata of your public certificate.", "type": "object", "required": [ "issuance_info", "key_algorithm", "rotation", "bundle_certs", "ca", "dns" ], "properties": { "signing_algorithm": { "$ref": "#/components/schemas/CertificateSigningAlgorithm" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "common_name": { "$ref": "#/components/schemas/CertificateCommonName" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" }, "issuance_info": { "$ref": "#/components/schemas/CertificateIssuanceInfo" }, "issuer": { "$ref": "#/components/schemas/CertificateIssuer" }, "key_algorithm": { "$ref": "#/components/schemas/CertificateKeyAlgorithm" }, "serial_number": { "$ref": "#/components/schemas/CertificateSerialNumber" }, "validity": { "$ref": "#/components/schemas/CertificateValidity" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "bundle_certs": { "type": "boolean", "readOnly": true, "description": "Indicates whether the issued certificate is bundled with intermediate certificates." }, "ca": { "type": "string", "readOnly": true, "minLength": 2, "maxLength": 128, "description": "The name of the certificate authority configuration." }, "dns": { "type": "string", "readOnly": true, "minLength": 2, "maxLength": 128, "description": "The name of the DNS provider configuration." } } }, "IAMCredentialsSecretMetadata": { "title": "IAMCredentialsSecretMetadata", "x-child-schema-name": "IAMCredentialsSecretMetadata", "description": "Properties of the metadata of your IAM credentials secret.", "x-terraform-datasource-name": "sm_iam_credentials_secret_metadata", "x-terraform-datasource-operations": { "read": "get_secret_metadata" }, "allOf": [ { "$ref": "#/components/schemas/CommonSecretMetadata" }, { "$ref": "#/components/schemas/IAMCredentialsSecretConcreteMetadata" } ] }, "IAMCredentialsSecretConcreteMetadata": { "title": "IAMCredentialsSecretConcreteMetadata", "x-child-schema-name": "IAMCredentialsSecretConcreteMetadata", "description": "Properties of the secret concrete metadata of your IAM credentials secret.", "type": "object", "required": [ "ttl", "reuse_api_key" ], "properties": { "ttl": { "$ref": "#/components/schemas/Ttl" }, "access_groups": { "$ref": "#/components/schemas/AccessGroupCollection" }, "api_key_id": { "$ref": "#/components/schemas/ApiKeyId" }, "service_id": { "$ref": "#/components/schemas/ServiceId" }, "account_id": { "$ref": "#/components/schemas/AccountId" }, "service_id_is_static": { "$ref": "#/components/schemas/ServiceIdIsStatic" }, "reuse_api_key": { "$ref": "#/components/schemas/ReuseApiKey" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "next_rotation_date": { "$ref": "#/components/schemas/NextRotationDate" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" } } }, "IAMCredentialsSecretMetadataPatch": { "title": "IAMCredentialsSecretMetadataPatch", "x-child-schema-name": "IAMCredentialsSecretMetadataPatch", "type": "object", "additionalProperties": false, "properties": { "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "ttl": { "$ref": "#/components/schemas/Ttl" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" } } }, "ArbitrarySecretConcreteMetadata": { "title": "ArbitrarySecretConcreteMetadata", "x-child-schema-name": "ArbitrarySecretConcreteMetadata", "description": "Properties of the concrete metadata of your arbitrary secret.", "properties": { "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" } } }, "ArbitrarySecretMetadata": { "title": "ArbitrarySecretMetadata", "x-child-schema-name": "ArbitrarySecretMetadata", "description": "Properties of the metadata of your arbitrary secret..", "x-terraform-datasource-name": "sm_arbitrary_secret_metadata", "x-terraform-datasource-operations": { "read": "get_secret_metadata" }, "allOf": [ { "$ref": "#/components/schemas/CommonSecretMetadata" }, { "$ref": "#/components/schemas/ArbitrarySecretConcreteMetadata" } ] }, "ArbitrarySecretVersionMetadata": { "title": "ArbitrarySecretVersionMetadata", "x-child-schema-name": "ArbitrarySecretVersionMetadata", "description": "Properties of the version metadata of your arbitrary secret.", "allOf": [ { "$ref": "#/components/schemas/CommonSecretVersionMetadata" }, { "$ref": "#/components/schemas/ArbitrarySecretVersionConcreteMetadata" } ] }, "ArbitrarySecretVersionConcreteMetadata": { "title": "ArbitrarySecretVersionConcreteMetadata", "x-child-schema-name": "ArbitrarySecretVersionConcreteMetadata", "description": "Properties of the version concrete metadata of your arbitrary secret.", "type": "object", "properties": { "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" } } }, "IAMCredentialsVersionConcreteMetadata": { "title": "IAMCredentialsSecretVersionConcreteMetadata", "x-child-schema-name": "IAMCredentialsSecretVersionConcreteMetadata", "description": "Properties of the version concrete metadata of your IAM Credentials secret.", "type": "object", "properties": { "api_key_id": { "$ref": "#/components/schemas/ApiKeyId" }, "service_id": { "$ref": "#/components/schemas/ServiceId" } } }, "UsernamePasswordSecretMetadata": { "title": "UsernamePasswordSecretMetadata", "x-child-schema-name": "UsernamePasswordSecretMetadata", "description": "Properties of the metadata of your user credentials secret.", "x-terraform-datasource-name": "sm_username_password_secret_metadata", "x-terraform-datasource-operations": { "read": "get_secret_metadata" }, "allOf": [ { "$ref": "#/components/schemas/CommonSecretMetadata" }, { "$ref": "#/components/schemas/UsernamePasswordSecretConcreteMetadata" } ] }, "UsernamePasswordSecretConcreteMetadata": { "title": "UsernamePasswordSecretConcreteMetadata", "x-child-schema-name": "UsernamePasswordSecretConcreteMetadata", "description": "Properties of the concrete metadata of your user credentials secret.", "type": "object", "required": [ "rotation" ], "properties": { "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" }, "next_rotation_date": { "$ref": "#/components/schemas/NextRotationDate" }, "password_generation_policy": { "$ref": "#/components/schemas/PasswordGenerationPolicyRO" } } }, "KVSecretVersionMetadata": { "title": "KVSecretVersionMetadata", "x-child-schema-name": "KVSecretVersionMetadata", "description": "Properties of the version metadata of your key-value secret.", "allOf": [ { "$ref": "#/components/schemas/CommonSecretVersionMetadata" } ] }, "UsernamePasswordSecretVersionMetadata": { "title": "UsernamePasswordSecretVersionMetadata", "x-child-schema-name": "UsernamePasswordSecretVersionMetadata", "description": "Properties of the version metadata of your user credentials secret.", "allOf": [ { "$ref": "#/components/schemas/CommonSecretVersionMetadata" } ] }, "IAMCredentialsSecretVersionMetadata": { "title": "IAMCredentialsSecretVersionMetadata", "x-child-schema-name": "IAMCredentialsSecretVersionMetadata", "description": "Properties of the version metadata of your IAM credentials secret.", "allOf": [ { "$ref": "#/components/schemas/CommonSecretVersionMetadata" }, { "$ref": "#/components/schemas/IAMCredentialsVersionConcreteMetadata" } ] }, "PasswordGenerationPolicy": { "title": "PasswordGenerationPolicy", "description": "Policy for auto-generated passwords.", "x-cli-option-name": "username-password-policy", "type": "object", "additionalProperties": false, "properties": { "length": { "$ref": "#/components/schemas/PasswordPolicyLength" }, "include_digits": { "$ref": "#/components/schemas/PasswordIncludeDigits" }, "include_symbols": { "$ref": "#/components/schemas/PasswordIncludeSymbols" }, "include_uppercase": { "$ref": "#/components/schemas/PasswordIncludeUppercase" } } }, "PasswordGenerationPolicyPatch": { "title": "PasswordGenerationPolicyPatch", "description": "Policy patch for auto-generated passwords. Policy properties that are included in the patch are updated.\nProperties that are not included in the patch remain unchanged.", "type": "object", "additionalProperties": false, "properties": { "length": { "$ref": "#/components/schemas/PasswordPolicyLengthNoDefault" }, "include_digits": { "$ref": "#/components/schemas/PasswordIncludeDigitsNoDefault" }, "include_symbols": { "$ref": "#/components/schemas/PasswordIncludeSymbolsNoDefault" }, "include_uppercase": { "$ref": "#/components/schemas/PasswordIncludeUppercaseNoDefault" } } }, "PasswordGenerationPolicyRO": { "title": "PasswordGenerationPolicyRO", "description": "Policy for auto-generated passwords.", "type": "object", "properties": { "length": { "$ref": "#/components/schemas/PasswordPolicyLengthNoDefault" }, "include_digits": { "$ref": "#/components/schemas/PasswordIncludeDigitsNoDefault" }, "include_symbols": { "$ref": "#/components/schemas/PasswordIncludeSymbolsNoDefault" }, "include_uppercase": { "$ref": "#/components/schemas/PasswordIncludeUppercaseNoDefault" } } }, "RotationPolicy": { "title": "RotationPolicy", "description": "This field indicates whether Secrets Manager rotates your secrets automatically. Supported secret types: username_password, private_cert, public_cert, iam_credentials, custom_credentials.", "type": "object", "anyOf": [ { "$ref": "#/components/schemas/CommonRotationPolicy" }, { "$ref": "#/components/schemas/PublicCertificateRotationPolicy" } ] }, "CommonRotationPolicy": { "title": "CommonRotationPolicy", "x-child-schema-name": "CommonRotationPolicy", "x-terraform-computed": true, "description": "This field indicates whether Secrets Manager rotates your secrets automatically.\n\nRotation interval cannot exceed the assiged TTL value.\n\nCustom Credentials: Minimum 6 hours, Maximum 3 months.\n\nService Credentials: Minimum 1 day, Maximum 3 months.\n\nIAM Credentials: Minimum 1 day, Maximum 3 months.\n\nPrivate certificate: Minimum 1 day, Maximum 24 months.\n\nUser credentials: Minimum 1 day, Maximum 24 months.", "type": "object", "required": [ "auto_rotate" ], "properties": { "auto_rotate": { "$ref": "#/components/schemas/AutoRotate" }, "interval": { "$ref": "#/components/schemas/RotationInterval" }, "unit": { "$ref": "#/components/schemas/RotationUnit" } } }, "PublicCertificateVersionMetadata": { "title": "PublicCertificateVersionMetadata", "x-child-schema-name": "PublicCertificateVersionMetadata", "description": "Properties of the version metadata of your public certificate.", "allOf": [ { "$ref": "#/components/schemas/CommonSecretVersionMetadata" }, { "$ref": "#/components/schemas/PublicCertificateVersionConcreteMetadata" } ] }, "PublicCertificateVersionConcreteMetadata": { "title": "PublicCertificateVersionConcreteMetadata", "x-child-schema-name": "PublicCertificateVersionConcreteMetadata", "description": "Properties of the concrete metadata of your public certificate version.", "type": "object", "properties": { "serial_number": { "$ref": "#/components/schemas/CertificateSerialNumber" }, "validity": { "$ref": "#/components/schemas/CertificateValidity" } } }, "PublicCertificateRotationPolicy": { "title": "PublicCertificateRotationPolicy", "x-child-schema-name": "PublicCertificateRotationPolicy", "description": "This field indicates whether Secrets Manager rotates your secrets automatically.\n\nFor public certificates, if `auto_rotate` is set to `true`, the service reorders your certificate for 31 days, before it expires.", "additionalProperties": false, "type": "object", "required": [ "auto_rotate", "rotate_keys" ], "properties": { "auto_rotate": { "$ref": "#/components/schemas/AutoRotate" }, "rotate_keys": { "$ref": "#/components/schemas/PublicCertificateRotateKeys" } } }, "PublicCertificateRotationObject": { "description": "Defines the rotation object that is used to manually rotate public certificates.", "type": "object", "additionalProperties": false, "x-cli-option-name": "public-cert-rotation", "properties": { "rotate_keys": { "$ref": "#/components/schemas/PublicCertificateRotateKeys" } } }, "PublicCertificateRotateKeys": { "type": "boolean", "description": "This field indicates whether Secrets Manager rotates the private key for your public certificate automatically.\n\nThe default is `false`. If it is set to `true`, the service generates and stores a new private key for your rotated certificate." }, "AutoRotate": { "type": "boolean", "description": "This field indicates whether Secrets Manager rotates your secret automatically.\n\nThe default is `false`. If `auto_rotate` is set to `true` the service rotates your secret based on the defined interval." }, "RotationInterval": { "type": "integer", "format": "int32", "description": "The length of the secret rotation time interval.", "minimum": 1, "maximum": 1000 }, "RotationUnit": { "type": "string", "description": "The units for the secret rotation time interval.", "enum": [ "day", "month", "hour" ] }, "Secret": { "title": "Secret", "description": "Your secret.", "anyOf": [ { "$ref": "#/components/schemas/ArbitrarySecret" }, { "$ref": "#/components/schemas/IAMCredentialsSecret" }, { "$ref": "#/components/schemas/ImportedCertificate" }, { "$ref": "#/components/schemas/KVSecret" }, { "$ref": "#/components/schemas/PrivateCertificate" }, { "$ref": "#/components/schemas/PublicCertificate" }, { "$ref": "#/components/schemas/ServiceCredentialsSecret" }, { "$ref": "#/components/schemas/UsernamePasswordSecret" }, { "$ref": "#/components/schemas/CustomCredentialsSecret" } ], "discriminator": { "propertyName": "secret_type", "mapping": { "arbitrary": "#/components/schemas/ArbitrarySecret", "iam_credentials": "#/components/schemas/IAMCredentialsSecret", "imported_cert": "#/components/schemas/ImportedCertificate", "kv": "#/components/schemas/KVSecret", "private_cert": "#/components/schemas/PrivateCertificate", "public_cert": "#/components/schemas/PublicCertificate", "service_credentials": "#/components/schemas/ServiceCredentialsSecret", "username_password": "#/components/schemas/UsernamePasswordSecret", "custom_credentials": "#/components/schemas/CustomCredentialsSecret" } } }, "SecretVersion": { "title": "SecretVersion", "description": "Your secret version.", "anyOf": [ { "$ref": "#/components/schemas/ArbitrarySecretVersion" }, { "$ref": "#/components/schemas/IAMCredentialsSecretVersion" }, { "$ref": "#/components/schemas/ImportedCertificateVersion" }, { "$ref": "#/components/schemas/KVSecretVersion" }, { "$ref": "#/components/schemas/PrivateCertificateVersion" }, { "$ref": "#/components/schemas/PublicCertificateVersion" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretVersion" }, { "$ref": "#/components/schemas/UsernamePasswordSecretVersion" }, { "$ref": "#/components/schemas/CustomCredentialsSecretVersion" } ], "discriminator": { "propertyName": "secret_type", "mapping": { "arbitrary": "#/components/schemas/ArbitrarySecretVersion", "iam_credentials": "#/components/schemas/IAMCredentialsSecretVersion", "imported_cert": "#/components/schemas/ImportedCertificateVersion", "kv": "#/components/schemas/KVSecretVersion", "private_cert": "#/components/schemas/PrivateCertificateVersion", "public_cert": "#/components/schemas/PublicCertificateVersion", "service_credentials": "#/components/schemas/ServiceCredentialsSecretVersion", "username_password": "#/components/schemas/UsernamePasswordSecretVersion", "custom_credentials": "#/components/schemas/CustomCredentialsSecretVersion" } } }, "ImportedCertificate": { "title": "ImportedCertificate", "x-child-schema-name": "ImportedCertificate", "description": "Your imported certificate.", "x-resource-name": "sm_imported_certificate", "x-terraform-resource-id": "id", "x-terraform-resource-name": "imported_certificate", "x-terraform-resource-operations": { "create": "create_secret", "read": "get_secret", "delete": "delete_secret", "update": "update_secret_metadata" }, "x-terraform-datasource-name": "sm_imported_certificate", "x-terraform-datasource-operations": { "read": "get_secret" }, "allOf": [ { "$ref": "#/components/schemas/ImportedCertificateMetadata" }, { "$ref": "#/components/schemas/ImportedCertificatePayload" } ] }, "PublicCertificate": { "title": "PublicCertificate", "x-child-schema-name": "PublicCertificate", "description": "Your public certificate.", "x-resource-name": "sm_public_certificate", "x-terraform-resource-id": "id", "x-terraform-resource-name": "public_certificate", "x-terraform-resource-operations": { "create": "create_secret", "read": "get_secret", "delete": "delete_secret", "update": "update_secret_metadata" }, "x-terraform-datasource-name": "sm_public_certificate", "x-terraform-datasource-operations": { "read": "get_secret" }, "allOf": [ { "$ref": "#/components/schemas/PublicCertificateMetadata" }, { "$ref": "#/components/schemas/PublicCertificatePayload" } ] }, "KVSecret": { "title": "KVSecret", "x-child-schema-name": "KVSecret", "description": "Your key-value secret.", "x-resource-name": "sm_kv_secret", "x-terraform-resource-id": "id", "x-terraform-resource-name": "kv_secret", "x-terraform-resource-operations": { "create": "create_secret", "read": "get_secret", "delete": "delete_secret", "update": "update_secret_metadata" }, "x-terraform-datasource-name": "sm_kv_secret", "x-terraform-datasource-operations": { "read": "get_secret" }, "allOf": [ { "$ref": "#/components/schemas/KVSecretMetadata" }, { "$ref": "#/components/schemas/KVSecretPayload" } ] }, "IAMCredentialsSecret": { "title": "IAMCredentialsSecret", "x-child-schema-name": "IAMCredentialsSecret", "description": "Your IAM credentials secret.", "x-resource-name": "sm_iam_credentials_secret", "x-terraform-resource-id": "id", "x-terraform-resource-name": "iam_credentials_secret", "x-terraform-resource-operations": { "create": "create_secret", "read": "get_secret", "delete": "delete_secret", "update": "update_secret_metadata" }, "x-terraform-datasource-name": "sm_iam_credentials_secret", "x-terraform-datasource-operations": { "read": "get_secret" }, "allOf": [ { "$ref": "#/components/schemas/IAMCredentialsSecretMetadata" }, { "$ref": "#/components/schemas/IAMCredentialsSecretPayload" } ] }, "ArbitrarySecret": { "title": "ArbitrarySecret", "x-child-schema-name": "ArbitrarySecret", "x-resource-name": "sm_arbitrary_secret", "x-terraform-resource-id": "id", "x-terraform-resource-name": "arbitrary_secret", "x-terraform-resource-operations": { "create": "create_secret", "read": "get_secret", "delete": "delete_secret", "update": "update_secret_metadata" }, "x-terraform-datasource-name": "sm_arbitrary_secret", "x-terraform-datasource-operations": { "read": "get_secret" }, "description": "Your arbitrary secret.", "allOf": [ { "$ref": "#/components/schemas/ArbitrarySecretMetadata" }, { "$ref": "#/components/schemas/ArbitrarySecretPayload" } ] }, "UsernamePasswordSecret": { "title": "UsernamePasswordSecret", "x-child-schema-name": "UsernamePasswordSecret", "description": "Your user credentials secret.", "type": "object", "x-resource-name": "sm_username_password_secret", "x-terraform-resource-id": "id", "x-terraform-resource-name": "username_password_secret", "x-terraform-resource-operations": { "create": "create_secret", "read": "get_secret", "delete": "delete_secret", "update": "update_secret_metadata" }, "x-terraform-datasource-name": "sm_username_password_secret", "x-terraform-datasource-operations": { "read": "get_secret" }, "allOf": [ { "$ref": "#/components/schemas/UsernamePasswordSecretMetadata" }, { "$ref": "#/components/schemas/UsernamePasswordSecretPayload" } ] }, "ServiceCredentialsSecretMetadata": { "title": "ServiceCredentialsSecretMetadata", "x-child-schema-name": "ServiceCredentialsSecretMetadata", "description": "The metadata properties for your service credentials secret.", "x-terraform-datasource-name": "sm_service_credentials_secret_metadata", "x-terraform-datasource-operations": { "read": "get_secret_metadata" }, "allOf": [ { "$ref": "#/components/schemas/CommonSecretMetadata" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretConcreteMetadata" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretSourceServicePayload" } ] }, "ServiceCredentialsSecretConcreteMetadata": { "title": "ServiceCredentialsSecretConcreteMetadata", "x-child-schema-name": "ServiceCredentialsSecretConcreteMetadata", "description": "The concrete metadata properties for your service credentials secret.", "type": "object", "properties": { "next_rotation_date": { "$ref": "#/components/schemas/NextRotationDate" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "ttl": { "$ref": "#/components/schemas/Ttl" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" } } }, "ServiceCredentialsSecretPayload": { "title": "ServiceCredentialsSecretPayload", "description": "The payload of a service credentials secret.", "x-child-schema-name": "ServiceCredentialsSecretPayload", "type": "object", "required": [ "credentials" ], "properties": { "credentials": { "$ref": "#/components/schemas/ServiceCredentialsSecretCredentials" } } }, "ServiceCredentialsSecretCredentials": { "title": "ServiceCredentialsSecretCredentials", "x-child-schema-name": "ServiceCredentialsSecretCredentials", "description": "The properties of the service credentials secret payload.", "type": "object", "additionalProperties": true, "properties": { "apikey": { "$ref": "#/components/schemas/ApiKeyServiceCredentialsSecretRO" }, "iam_apikey_description": { "$ref": "#/components/schemas/ServiceCredentialsIamApikeyDescription" }, "iam_apikey_id": { "$ref": "#/components/schemas/ServiceCredentialsIamApikeyId" }, "iam_apikey_name": { "$ref": "#/components/schemas/ServiceCredentialsIamApikeyName" }, "iam_role_crn": { "$ref": "#/components/schemas/ServiceCredentialsIamRoleCrn" }, "iam_serviceid_crn": { "$ref": "#/components/schemas/ServiceCredentialsIamServiceidCrn" } } }, "ServiceCredentialsSecretSourceServicePayload": { "title": "ServiceCredentialsSecretSourceServicePayload", "description": "The source service payload for service credentials secret.", "x-child-schema-name": "ServiceCredentialsSecretSourceServicePayload", "type": "object", "required": [ "source_service" ], "properties": { "source_service": { "$ref": "#/components/schemas/ServiceCredentialsSecretSourceServiceRO" } } }, "ServiceCredentialsSecretSourceServiceRO": { "title": "ServiceCredentialsSecretSourceService", "x-child-schema-name": "ServiceCredentialsSecretSourceService", "description": "The properties of the resource key that was created for this source service instance.", "type": "object", "required": [ "instance" ], "properties": { "instance": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceInstance" }, "parameters": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceParameters" }, "role": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceRole" }, "iam": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceIam" }, "resource_key": { "$ref": "#/components/schemas/ServiceCredentialsResourceKey" } } }, "ServiceCredentialsSecretSourceService": { "title": "ServiceCredentialsSecretSourceService", "x-child-schema-name": "ServiceCredentialsSecretSourceService", "description": "The properties that are required to create the service credentials for the specified source service instance.", "type": "object", "required": [ "instance" ], "properties": { "instance": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceInstance" }, "parameters": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceParameters" }, "role": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceRole" } } }, "ServiceCredentialsSecret": { "title": "ServiceCredentialsSecret", "x-child-schema-name": "ServiceCredentialsSecret", "description": "Your service credentials secret.", "type": "object", "x-resource-name": "sm_service_credentials_secret", "x-terraform-resource-id": "id", "x-terraform-resource-name": "service_credentials_secret", "x-terraform-resource-operations": { "create": "create_secret", "read": "get_secret", "delete": "delete_secret", "update": "update_secret_metadata" }, "x-terraform-datasource-name": "sm_service_credentials_secret", "x-terraform-datasource-operations": { "read": "get_secret" }, "allOf": [ { "$ref": "#/components/schemas/ServiceCredentialsSecretMetadata" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretPayload" } ] }, "CustomCredentialsSecretPayload": { "title": "CustomCredentialsSecretPayload", "description": "The payload of a custom credentials secret.", "x-child-schema-name": "CustomCredentialsSecretPayload", "type": "object", "required": [ "credentials_content" ], "properties": { "credentials_content": { "$ref": "#/components/schemas/CustomCredentialsFields" } } }, "CustomCredentialsSecretConcreteMetadata": { "title": "CustomCredentialsSecretConcreteMetadata", "x-child-schema-name": "CustomCredentialsSecretConcreteMetadata", "description": "The concrete metadata properties for your custom credentials secret.", "type": "object", "required": [ "task_count", "queued_task_count", "configuration" ], "properties": { "next_rotation_date": { "$ref": "#/components/schemas/NextRotationDate" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "ttl": { "$ref": "#/components/schemas/Ttl" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" }, "task_count": { "$ref": "#/components/schemas/SecretTasksTotal" }, "processing_task_id": { "$ref": "#/components/schemas/TaskId" }, "queued_task_count": { "$ref": "#/components/schemas/SecretQueuedTasks" }, "last_failed_task_id": { "$ref": "#/components/schemas/TaskId" }, "last_rotation_failed": { "$ref": "#/components/schemas/LastRotationFailed" }, "configuration": { "$ref": "#/components/schemas/CustomCredentialsConfigurationName" }, "parameters": { "$ref": "#/components/schemas/CustomCredentialsFields" } } }, "CustomCredentialsSecretMetadata": { "title": "CustomCredentialsSecretMetadata", "x-child-schema-name": "CustomCredentialsSecretMetadata", "description": "The metadata properties for your custom credentials secret.", "x-terraform-datasource-name": "sm_custom_credentials_secret_metadata", "x-terraform-datasource-operations": { "read": "get_secret_metadata" }, "allOf": [ { "$ref": "#/components/schemas/CommonSecretMetadata" }, { "$ref": "#/components/schemas/CustomCredentialsSecretConcreteMetadata" } ] }, "CustomCredentialsSecret": { "title": "CustomCredentialsSecret", "x-child-schema-name": "CustomCredentialsSecret", "description": "Your custom credentials secret.", "type": "object", "x-resource-name": "sm_custom_credentials_secret", "x-terraform-resource-id": "id", "x-terraform-resource-name": "custom_credentials_secret", "x-terraform-resource-operations": { "create": "create_secret", "read": "get_secret", "delete": "delete_secret", "update": "update_secret_metadata" }, "x-terraform-datasource-name": "sm_custom_credentials_secret", "x-terraform-datasource-operations": { "read": "get_secret" }, "allOf": [ { "$ref": "#/components/schemas/CustomCredentialsSecretMetadata" }, { "$ref": "#/components/schemas/CustomCredentialsSecretPayload" } ] }, "ImportedCertificateVersion": { "title": "ImportedCertificateVersion", "x-child-schema-name": "ImportedCertificateVersion", "description": "Versions of your imported certificate.", "allOf": [ { "$ref": "#/components/schemas/ImportedCertificateVersionMetadata" }, { "$ref": "#/components/schemas/ImportedCertificatePayload" } ] }, "PublicCertificateVersion": { "title": "PublicCertificateVersion", "x-child-schema-name": "PublicCertificateVersion", "description": "Versions of your public certificate.", "allOf": [ { "$ref": "#/components/schemas/PublicCertificateVersionMetadata" }, { "$ref": "#/components/schemas/PublicCertificatePayload" } ] }, "KVSecretVersion": { "title": "KVSecretVersion", "x-child-schema-name": "KVSecretVersion", "description": "Your key-value secret version.", "allOf": [ { "$ref": "#/components/schemas/KVSecretVersionMetadata" }, { "$ref": "#/components/schemas/KVSecretPayload" } ] }, "ArbitrarySecretVersion": { "title": "ArbitrarySecretVersion", "x-child-schema-name": "ArbitrarySecretVersion", "x-resource-name": "sm_arbitrary_secret_version", "x-terraform-resource-id": "id", "x-terraform-resource-name": "arbitrary_secret_version", "x-terraform-resource-operations": { "create": "create_secret_version", "read": "get_secret_version", "update": "update_secret_version_metadata", "delete": "delete_secret_version_data" }, "x-terraform-datasource-name": "arbitrary_sm_secret_version", "x-terraform-datasource-operations": { "read": "get_secret_version" }, "description": "Your arbitrary secret version.", "allOf": [ { "$ref": "#/components/schemas/ArbitrarySecretVersionMetadata" }, { "$ref": "#/components/schemas/ArbitrarySecretPayload" } ] }, "UsernamePasswordSecretVersion": { "title": "UsernamePasswordSecretVersion", "x-child-schema-name": "UsernamePasswordSecretVersion", "description": "Your user credentials secret version.", "allOf": [ { "$ref": "#/components/schemas/UsernamePasswordSecretVersionMetadata" }, { "$ref": "#/components/schemas/UsernamePasswordSecretPayload" } ] }, "ServiceCredentialsSecretVersion": { "title": "ServiceCredentialsSecretVersion", "x-child-schema-name": "ServiceCredentialsSecretVersion", "description": "Your service credentials secret version.", "allOf": [ { "$ref": "#/components/schemas/ServiceCredentialsSecretVersionMetadata" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretPayload" } ] }, "ServiceCredentialsSecretVersionMetadata": { "title": "ServiceCredentialsSecretVersionMetadata", "x-child-schema-name": "ServiceCredentialsSecretVersionMetadata", "description": "The version metadata properties for your service credentials secret.", "allOf": [ { "$ref": "#/components/schemas/CommonSecretVersionMetadata" }, { "$ref": "#/components/schemas/ServiceCredentialsSecretVersionConcreteMetadata" } ] }, "ServiceCredentialsSecretVersionConcreteMetadata": { "title": "ServiceCredentialsSecretVersionConcreteMetadata", "x-child-schema-name": "ServiceCredentialsSecretVersionConcreteMetadata", "description": "The concrete metadata properties for your service credentials secret's version.", "type": "object", "properties": { "resource_key": { "$ref": "#/components/schemas/ServiceCredentialsResourceKey" } } }, "CustomCredentialsSecretVersion": { "title": "CustomCredentialsSecretVersion", "x-child-schema-name": "CustomCredentialsSecretVersion", "description": "Your custom credentials secret version.", "allOf": [ { "$ref": "#/components/schemas/CustomCredentialsSecretVersionMetadata" }, { "$ref": "#/components/schemas/CustomCredentialsSecretPayload" } ] }, "CustomCredentialsSecretVersionMetadata": { "title": "CustomCredentialsSecretVersionMetadata", "x-child-schema-name": "CustomCredentialsSecretVersionMetadata", "description": "The version metadata properties for your custom credentials secret.", "allOf": [ { "$ref": "#/components/schemas/CommonSecretVersionMetadata" }, { "$ref": "#/components/schemas/CustomCredentialsSecretVersionConcreteMetadata" } ] }, "CustomCredentialsSecretVersionConcreteMetadata": { "title": "CustomCredentialsSecretVersionConcreteMetadata", "x-child-schema-name": "CustomCredentialsSecretVersionMetadataFields", "type": "object", "properties": { "credentials_id": { "$ref": "#/components/schemas/CredentialsId" } } }, "CredentialsId": { "title": "CredentialsId", "type": "string", "description": "Credentials created by the custom credentials system.", "pattern": "^(.*?)$", "minLength": 1, "maxLength": 256 }, "IAMCredentialsSecretVersion": { "title": "IAMCredentialsSecretVersion", "x-child-schema-name": "IAMCredentialsSecretVersion", "description": "Your IAM credentials version.", "allOf": [ { "$ref": "#/components/schemas/IAMCredentialsSecretVersionMetadata" }, { "$ref": "#/components/schemas/IAMCredentialsSecretPayload" } ] }, "PrivateCertificatePrototype": { "title": "PrivateCertificatePrototype", "x-child-schema-name": "PrivateCertificatePrototype", "type": "object", "additionalProperties": false, "required": [ "secret_type", "name", "certificate_template", "common_name" ], "properties": { "secret_type": { "$ref": "#/components/schemas/SecretType" }, "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "certificate_template": { "$ref": "#/components/schemas/PrivateCertificateTemplateName" }, "common_name": { "$ref": "#/components/schemas/PrivateCertificateCommonName" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "ip_sans": { "$ref": "#/components/schemas/PrivateCertificateIpSans" }, "uri_sans": { "$ref": "#/components/schemas/PrivateCertificateUriSans" }, "other_sans": { "$ref": "#/components/schemas/PrivateCertificateOtherSans" }, "csr": { "$ref": "#/components/schemas/PrivateCertificateCSR" }, "format": { "$ref": "#/components/schemas/PrivateCertificateFormat" }, "private_key_format": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyFormat" }, "exclude_cn_from_sans": { "$ref": "#/components/schemas/PrivateCertificateExcludeCnFromSans" }, "ttl": { "$ref": "#/components/schemas/PrivateCertificateTTL" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" } } }, "PrivateCertificate": { "title": "PrivateCertificate", "x-child-schema-name": "PrivateCertificate", "description": "Your private certificate.", "x-resource-name": "sm_private_certificate", "x-terraform-resource-id": "id", "x-terraform-resource-name": "private_certificate", "x-terraform-resource-operations": { "create": "create_secret", "read": "get_secret", "delete": "delete_secret", "update": "update_secret_metadata" }, "x-terraform-datasource-name": "sm_private_certificate", "x-terraform-datasource-operations": { "read": "get_secret" }, "allOf": [ { "$ref": "#/components/schemas/PrivateCertificateMetadata" }, { "$ref": "#/components/schemas/PrivateCertificatePayload" } ] }, "PrivateCertificateVersion": { "title": "PrivateCertificateVersion", "x-child-schema-name": "PrivateCertificateVersion", "description": "Your private certificate version.", "allOf": [ { "$ref": "#/components/schemas/PrivateCertificateVersionMetadata" }, { "$ref": "#/components/schemas/PrivateCertificatePayload" } ] }, "PrivateCertificateMetadata": { "title": "PrivateCertificateMetadata", "x-child-schema-name": "PrivateCertificateMetadata", "description": "Properties of the metadata of your private certificate.", "x-terraform-datasource-name": "sm_private_certificate_metadata", "x-terraform-datasource-operations": { "read": "get_secret_metadata" }, "allOf": [ { "$ref": "#/components/schemas/CommonSecretMetadata" }, { "$ref": "#/components/schemas/PrivateCertificateConcreteMetadata" } ] }, "PrivateCertificateConcreteMetadata": { "title": "PrivateCertificateConcreteMetadata", "x-child-schema-name": "PrivateCertificateConcreteMetadata", "description": "Properties of the concrete metadata of your private certificate.", "type": "object", "required": [ "certificate_authority", "certificate_template", "common_name", "expiration_date", "issuer", "key_algorithm", "signing_algorithm", "serial_number", "validity" ], "properties": { "signing_algorithm": { "$ref": "#/components/schemas/CertificateSigningAlgorithm" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "certificate_authority": { "$ref": "#/components/schemas/PrivateCertificateAuthority" }, "certificate_template": { "$ref": "#/components/schemas/PrivateCertificateTemplateName" }, "common_name": { "$ref": "#/components/schemas/PrivateCertificateCommonName" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" }, "issuer": { "$ref": "#/components/schemas/CertificateIssuer" }, "key_algorithm": { "$ref": "#/components/schemas/CertificateKeyAlgorithmRO" }, "next_rotation_date": { "$ref": "#/components/schemas/NextRotationDate" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" }, "serial_number": { "$ref": "#/components/schemas/CertificateSerialNumber" }, "validity": { "$ref": "#/components/schemas/CertificateValidity" }, "revocation_time_seconds": { "$ref": "#/components/schemas/PrivateCertificateRevocationTime" }, "revocation_time_rfc3339": { "$ref": "#/components/schemas/PrivateCertificateRevocationTimeRfc3339" } } }, "PrivateCertificateVersionMetadata": { "title": "PrivateCertificateVersionMetadata", "x-child-schema-name": "PrivateCertificateVersionMetadata", "description": "Properties of the version metadata of your private certificate.", "allOf": [ { "$ref": "#/components/schemas/CommonSecretVersionMetadata" }, { "$ref": "#/components/schemas/PrivateCertificateVersionConcreteMetadata" } ] }, "PrivateCertificateVersionConcreteMetadata": { "title": "PrivateCertificateVersionConcreteMetadata", "x-child-schema-name": "PrivateCertificateVersionConcreteMetadata", "description": "Properties of the concrete metadata of your private certificate version.", "type": "object", "required": [ "serial_number", "validity" ], "properties": { "serial_number": { "$ref": "#/components/schemas/CertificateSerialNumber" }, "validity": { "$ref": "#/components/schemas/CertificateValidity" } } }, "PrivateCertificatePayload": { "title": "PrivateCertificatePayload", "description": "The payload of your private certificate.", "x-child-schema-name": "PrivateCertificatePayload", "type": "object", "required": [ "certificate", "private_key" ], "properties": { "certificate": { "$ref": "#/components/schemas/Certificate" }, "private_key": { "$ref": "#/components/schemas/CertificatePrivateKey" }, "issuing_ca": { "$ref": "#/components/schemas/PrivateCertificateIssuingCA" }, "ca_chain": { "$ref": "#/components/schemas/PrivateCertificateCAChain" } } }, "PrivateCertificateMetadataPatch": { "title": "PrivateCertificateMetadataPatch", "x-child-schema-name": "PrivateCertificateMetadataPatch", "type": "object", "additionalProperties": false, "properties": { "name": { "$ref": "#/components/schemas/SecretName" }, "description": { "$ref": "#/components/schemas/SecretDescription" }, "labels": { "$ref": "#/components/schemas/LabelCollection" }, "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "rotation": { "$ref": "#/components/schemas/RotationPolicy" } } }, "PrivateCertificateVersionPrototype": { "title": "PrivateCertificateVersionPrototype", "x-child-schema-name": "PrivateCertificateVersionPrototype", "type": "object", "additionalProperties": false, "properties": { "custom_metadata": { "$ref": "#/components/schemas/SecretCustomMetadata" }, "version_custom_metadata": { "$ref": "#/components/schemas/VersionCustomMetadata" }, "csr": { "$ref": "#/components/schemas/PrivateCertificateCSR" } } }, "PrivateCertificateCommonName": { "title": "PrivateCertificateCommonName", "description": "The Common Name (CN) represents the server name that is protected by the SSL certificate.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "certificate-common-name", "minLength": 4, "maxLength": 128, "pattern": "(.*?)", "example": "localhost" }, "PrivateCertificateAuthority": { "type": "string", "description": "The intermediate certificate authority that signed this certificate.", "readOnly": true, "minLength": 2, "maxLength": 128 }, "PrivateCertificateTemplateName": { "type": "string", "description": "The name of the certificate template.", "pattern": "^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$", "x-cli-option-name": "private-cert-template-name", "minLength": 2, "maxLength": 128, "example": "cert-template-1", "x-terraform-force-new": true }, "PrivateCertificateRevocationTime": { "type": "integer", "format": "int64", "description": "The timestamp of the certificate revocation.", "readOnly": true, "minimum": 1577836800, "maximum": 4733510400 }, "PrivateCertificateRevocationTimeRfc3339": { "type": "string", "format": "date-time", "description": "The date and time that the certificate was revoked. The date format follows `RFC 3339`.", "readOnly": true, "minLength": 0, "maxLength": 35, "example": "2021-11-01T08:00:20.660976Z" }, "PrivateCertificateTTL": { "description": "The time-to-live (TTL) to assign to a private certificate.\n\nThe value can be supplied as a string representation of a duration in hours, for example '12h'.\nThe value can't exceed the `max_ttl` that is defined in the associated certificate template.", "type": "string", "x-terraform-force-new": true, "x-cli-option-name": "private-cert-ttl", "x-cli-description": "The time-to-live (TTL) to assign to a private certificate.", "pattern": "^[0-9]+[s,m,h,d]{0,1}$", "minLength": 2, "maxLength": 10, "example": "12h" }, "PrivateCertificateFormat": { "description": "The format of the returned data.", "x-terraform-force-new": true, "x-terraform-computed": true, "type": "string", "x-cli-option-name": "private-cert-format", "enum": [ "pem", "pem_bundle" ] }, "PrivateCertificatePrivateKeyFormat": { "description": "The format of the generated private key.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "private-cert-private-key-format", "enum": [ "der", "pkcs8" ], "default": "der" }, "PrivateCertificateIpSans": { "description": "The IP Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "private-cert-ip-sans", "pattern": "(.*?)", "minLength": 2, "maxLength": 2048, "example": "1.1.1.1, 2.2.2.2" }, "PrivateCertificateUriSans": { "description": "The URI Subject Alternative Names to define for the CA certificate, in a comma-delimited list.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "private-cert-uri-sans", "pattern": "(.*?)", "minLength": 2, "maxLength": 2048 }, "PrivateCertificateOtherSans": { "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.\n\nThe alternative names must\nmatch the values that are specified in the `allowed_other_sans` field in the associated certificate template.\nThe format is the same as OpenSSL: `::` where the current valid type is `UTF8`.", "type": "array", "x-cli-option-name": "private-cert-other-sans", "x-cli-description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the CA certificate.", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 1024 }, "x-terraform-force-new": true, "x-terraform-computed": true, "example": [ "2.5.4.5;UTF8:*.example.com" ] }, "PrivateCertificateExcludeCnFromSans": { "description": "This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).\n\nIf the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be useful\nif the common name is a human-readable identifier, instead of a hostname or an email address.", "type": "boolean", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "private-cert-exclude-cn-from-sans", "x-cli-description": "This parameter controls whether the common name is excluded from Subject Alternative Names (SANs)." }, "PrivateCertificateIssuingCA": { "readOnly": true, "type": "string", "description": "The PEM-encoded certificate of the certificate authority that signed and issued this certificate.", "pattern": "^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$", "minLength": 0, "maxLength": 100000 }, "PrivateCertificateCAChain": { "description": "The chain of certificate authorities that are associated with the certificate.", "readOnly": true, "type": "array", "minItems": 1, "maxItems": 16, "items": { "type": "string", "pattern": "^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$", "minLength": 0, "maxLength": 100000 } }, "PrivateCertificateCSR": { "description": "The certificate signing request.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "private-cert-csr", "pattern": "^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$", "minLength": 2, "maxLength": 4096 }, "PrivateCertificateExpiration": { "description": "The certificate expiration time.", "type": "integer", "format": "int64", "readOnly": true, "example": 1982238335, "minimum": 1577836800, "maximum": 4733510400 }, "AutoRotated": { "description": "Indicates whether the version of the secret was created by automatic rotation.", "type": "boolean" }, "ResourceCrn": { "title": "ResourceCrn", "description": "A CRN that uniquely identifies an IBM Cloud resource.", "type": "string", "format": "crn", "pattern": "^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@/]|%[0-9A-Z]{2})*){8}$", "minLength": 9, "maxLength": 512 }, "ServiceCredentialsSourceServiceInstance": { "title": "ServiceCredentialsSourceServiceInstance", "description": "The source service instance identifier.", "type": "object", "properties": { "crn": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceInstanceCrn" } } }, "ServiceCredentialsSourceServiceInstanceCrn": { "title": "ServiceCredentialsSourceServiceInstanceCrn", "description": "A CRN that uniquely identifies a service credentials source.", "type": "string", "format": "crn", "pattern": "^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@/]|%[0-9A-Z]{2})*){8}$", "minLength": 9, "maxLength": 512 }, "ServiceCredentialsSourceServiceParameters": { "title": "ServiceCredentialsSourceServiceParameters", "description": "Configuration options represented as key-value pairs. Service-defined options are used in the generation of credentials for some services. For example, Cloud Object Storage accepts the optional boolean parameter HMAC for creating specific kind of credentials.", "type": "object", "properties": { "serviceid_crn": { "$ref": "#/components/schemas/ServiceIdCrnForReuse" } }, "additionalProperties": true, "example": { "serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/22018f3c34ff4ff193698d15ca316946::serviceid:ServiceId-6183f10e-6db1-44e8-806c-cfb711b87feb", "HMAC": true } }, "ServiceCredentialsSourceServiceRole": { "title": "ServiceCredentialsSourceServiceRole", "description": "The service-specific custom role. CRN is accepted. The role is assigned as part of an access policy to any auto-generated IAM service ID. If you provide an existing service ID, it is added to the access policy for that ID. If a role is not provided, any new service IDs that are autogenerated, will not have an assigned access policy and provided service IDs are not changed in any way. Refer to the service documentation for supported roles.", "type": "object", "required": [ "crn" ], "properties": { "crn": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceRoleCrn" } } }, "ServiceCredentialsSourceServiceRoleCrn": { "title": "ServiceCredentialsSourceServiceRoleCrn.", "description": "The service role CRN.", "type": "string", "format": "crn", "pattern": "^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@/]|%[0-9A-Z]{2})*){8}$", "minLength": 9, "maxLength": 512 }, "ServiceCredentialsResourceKey": { "title": "ServiceCredentialsResourceKey", "description": "The source service resource key data of the generated service credentials.", "type": "object", "properties": { "crn": { "$ref": "#/components/schemas/ServiceCredentialsResourceKeyCrn" }, "name": { "$ref": "#/components/schemas/ServiceCredentialsResourceKeyName" } } }, "ServiceCredentialsSourceServiceIam": { "title": "ServiceCredentialsSourceServiceIam", "description": "The source service IAM data is returned in case IAM credentials where created for this secret.", "type": "object", "properties": { "apikey": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceIamApikey" }, "role": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceIamRole" }, "serviceid": { "$ref": "#/components/schemas/ServiceCredentialsSourceServiceIamServiceid" } } }, "ServiceCredentialsSourceServiceIamApikey": { "title": "ServiceCredentialsSourceServiceIamApikey", "description": "The IAM apikey metadata for the IAM credentials that were generated.", "type": "object", "properties": { "description": { "$ref": "#/components/schemas/ServiceCredentialsIamApikeyDescription" }, "id": { "$ref": "#/components/schemas/ServiceCredentialsIamApikeyId" }, "name": { "$ref": "#/components/schemas/ServiceCredentialsIamApikeyName" } } }, "ServiceCredentialsSourceServiceIamServiceid": { "title": "ServiceCredentialsSourceServiceIamServiceid", "description": "The IAM serviceid for the generated service credentials.", "type": "object", "properties": { "crn": { "$ref": "#/components/schemas/ServiceCredentialsIamServiceidCrn" } } }, "ServiceCredentialsSourceServiceIamRole": { "title": "ServiceCredentialsSourceServiceIamRole", "description": "The IAM role for the generate service credentials.", "type": "object", "properties": { "crn": { "$ref": "#/components/schemas/ServiceCredentialsIamRoleCrn" } } }, "ServiceCredentialsIamApikeyDescription": { "title": "ServiceCredentialsIamApikeyDescription", "description": "The IAM API key description for the generated service credentials.", "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 512, "readOnly": true }, "ServiceCredentialsIamApikeyId": { "title": "ServiceCredentialsIamApikeyID", "description": "The IAM API key id for the generated service credentials.", "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 512, "readOnly": true }, "ServiceCredentialsIamApikeyName": { "title": "ServiceCredentialsIamApikeyName", "description": "The IAM API key name for the generated service credentials.", "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 512, "readOnly": true }, "ServiceCredentialsIamRoleCrn": { "title": "ServiceCredentialsIamRoleCrn", "description": "The IAM role CRN assigned to the generated service credentials.", "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 512, "readOnly": true }, "ServiceCredentialsIamServiceidCrn": { "title": "ServiceCredentialsIamServiceidCrn", "description": "The IAM Service ID CRN.", "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 512, "readOnly": true }, "ServiceCredentialsResourceKeyName": { "title": "ServiceCredentialsResourceKeyName", "description": "The resource key name of the generated service credentials.", "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 512, "readOnly": true }, "ServiceCredentialsResourceKeyCrn": { "title": "ServiceCredentialsResourceKeyCrn", "description": "The resource key CRN of the generated service credentials.", "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 512, "readOnly": true }, "ServiceIdCrnForReuse": { "title": "ServiceIdCrn", "description": "An optional platform defined option to reuse an existing IAM Service ID for the role assignment.", "type": "string", "pattern": "^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@/]|%[0-9A-Z]{2})*){8}$", "minLength": 9, "maxLength": 512 }, "Uuid": { "title": "UUID", "description": "A UUID identifier.", "type": "string", "format": "identifier", "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", "minLength": 36, "maxLength": 36, "example": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5" }, "SecretVersionId": { "title": "SecretVersionId", "description": "A UUID identifier, or `current` or `previous` secret version aliases.", "type": "string", "pattern": "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$", "minLength": 7, "maxLength": 36, "example": "current" }, "SecretGroupId": { "title": "SecretGroupId", "description": "A UUID identifier, or `default` secret group.", "type": "string", "pattern": "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$", "x-cli-option-name": "secret-group-id", "minLength": 7, "maxLength": 36, "x-terraform-force-new": true, "example": "default" }, "GroupsFilterParam": { "type": "string", "pattern": "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$", "minLength": 7, "maxLength": 36 }, "SecretTypeConfigurationFilterParam": { "type": "string", "enum": [ "iam_credentials", "private_cert", "public_cert", "custom_credentials" ] }, "LabelFilterParam": { "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 64 }, "SecretTypeFilterParam": { "type": "string", "enum": [ "arbitrary", "iam_credentials", "imported_cert", "kv", "private_cert", "public_cert", "service_credentials", "username_password", "custom_credentials" ] }, "CollectionTotalCount": { "title": "CollectionTotalCount", "description": "The total number of resources in a collection.", "type": "integer", "format": "int32", "minimum": 0, "maximum": 10000000 }, "CollectionHref": { "title": "CollectionHref", "description": "A URL that points to a page in a collection", "type": "string", "format": "url", "minLength": 0, "maxLength": 256 }, "PaginatedCollection": { "title": "PaginatedCollection", "description": "The set of standard fields that are returned in a paginated collection response.", "type": "object", "required": [ "limit", "offset", "total_count", "first", "last" ], "properties": { "total_count": { "$ref": "#/components/schemas/CollectionTotalCount" }, "limit": { "$ref": "#/components/schemas/PaginatedCollectionLimit" }, "offset": { "$ref": "#/components/schemas/PaginatedCollectionOffset" }, "first": { "$ref": "#/components/schemas/PaginatedCollectionFirst" }, "next": { "$ref": "#/components/schemas/PaginatedCollectionNext" }, "previous": { "$ref": "#/components/schemas/PaginatedCollectionPrevious" }, "last": { "$ref": "#/components/schemas/PaginatedCollectionLast" } } }, "PaginatedCollectionLimit": { "title": "PaginatedCollectionLimit", "description": "The number of items that are retrieved in a collection.", "type": "integer", "format": "int32", "minimum": 0, "maximum": 10000, "default": 25 }, "PaginatedCollectionOffset": { "title": "PaginatedCollectionOffset", "description": "The number of items that are skipped in a collection.", "type": "integer", "format": "int32", "minimum": 0, "maximum": 10000000, "default": 25 }, "PaginatedCollectionFirst": { "title": "PaginatedCollectionFirst", "type": "object", "description": "A URL that points to the first page in a collection.", "required": [ "href" ], "x-terraform-exclude": true, "properties": { "href": { "$ref": "#/components/schemas/CollectionHref" } } }, "PaginatedCollectionNext": { "title": "PaginatedCollectionNext", "type": "object", "description": "A URL that points to the next page in a collection.", "required": [ "href" ], "x-terraform-exclude": true, "properties": { "href": { "$ref": "#/components/schemas/CollectionHref" } } }, "PaginatedCollectionPrevious": { "title": "PaginatedCollectionPrevious", "type": "object", "description": "A URL that points to the previous page in a collection.", "required": [ "href" ], "x-terraform-exclude": true, "properties": { "href": { "$ref": "#/components/schemas/CollectionHref" } } }, "PaginatedCollectionLast": { "title": "PaginatedCollectionLast", "type": "object", "description": "A URL that points to the last page in a collection.", "required": [ "href" ], "x-terraform-exclude": true, "properties": { "href": { "$ref": "#/components/schemas/CollectionHref" } } }, "CreatedBy": { "title": "CreatedBy", "description": "The unique identifier that is associated with the entity that created the secret.", "type": "string", "minLength": 4, "maxLength": 256, "example": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21" }, "UpdatedBy": { "title": "UpdatedBy", "description": "The unique identifier that is associated with the entity that updated the resource.", "type": "string", "pattern": "^(.*?)$", "minLength": 4, "maxLength": 256, "example": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21" }, "DateTime": { "title": "DateTime", "description": "The date-time format follows `RFC 3339`.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 20, "example": "2025-04-12T23:20:50Z" }, "CreationDate": { "title": "CreationDate", "description": "The date when the resource was created. The date format follows `RFC 3339`.", "type": "string", "format": "date-time", "minLength": 0, "maxLength": 35, "example": "2022-04-12T23:20:50.52Z" }, "RetrievalDate": { "title": "RetrievalDate", "description": "The date when the data of the secret was last retrieved. The date format follows RFC 3339. Epoch date if there is no record of secret data retrieval.", "type": "string", "format": "date-time", "minLength": 0, "maxLength": 35, "example": "2025-04-12T23:20:50.52Z" }, "UpdateAt": { "title": "UpdateAt", "description": "The date when a resource was modified. The date format follows `RFC 3339`.", "type": "string", "format": "date-time", "minLength": 0, "maxLength": 35, "example": "2022-04-12T23:20:50.52Z" }, "ExpirationDate": { "title": "ExpirationDate", "description": "The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types: Arbitrary, username_password", "type": "string", "format": "date-time", "x-terraform-force-new": true, "example": "2033-04-12T23:20:50.52Z", "minLength": 2, "maxLength": 64, "nullable": true }, "ExpirationDateRO": { "title": "ExpirationDateRO", "description": "The date when the secret material expires. The date format follows the `RFC 3339` format. Supported secret types: arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, username_password, and custom_credentials.", "type": "string", "format": "date-time", "x-terraform-force-new": true, "example": "2033-04-12T23:20:50.52Z", "readOnly": true, "nullable": true }, "SecretVersionPayloadAvailable": { "description": "Indicates whether the secret payload is available in this secret version.", "type": "boolean" }, "SecretCustomMetadata": { "description": "The secret metadata that a user can customize.", "type": "object", "additionalProperties": true, "example": { "key": "value" } }, "VersionCustomMetadata": { "description": "The secret version metadata that a user can customize.", "type": "object", "additionalProperties": true, "example": { "key": "value" } }, "SecretGroupName": { "title": "SecretGroupName", "description": "The name of your secret group.", "type": "string", "pattern": "^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$", "minLength": 2, "maxLength": 64, "example": "my-secret-group" }, "SecretGroupNameRO": { "title": "SecretGroupNameRO", "description": "The name of your existing secret group.", "type": "string", "readOnly": true, "pattern": "(.*?)", "minLength": 2, "maxLength": 64, "example": "my-secret-group" }, "SecretGroupNameV1Compatible": { "title": "SecretGroupName", "description": "The name of your existing secret group.", "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 64, "example": "default" }, "SecretGroupDescription": { "title": "SecretGroupDescription", "description": "An extended description of your secret group.\n\nTo protect your privacy, do not use personal data, such as your name or location, as a description for your\nsecret group.", "x-cli-description": "An extended description of your secret group.", "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 1024, "example": "Extended description for this group." }, "SecretType": { "title": "SecretType", "description": "The secret type. Supported types are arbitrary, imported_cert, public_cert, private_cert, iam_credentials, service_credentials, kv, and username_password.", "x-cli-option-name": "secret-type", "x-cli-description": "The secret type.", "type": "string", "enum": [ "arbitrary", "iam_credentials", "imported_cert", "kv", "private_cert", "public_cert", "service_credentials", "username_password", "custom_credentials" ] }, "SecretActionType": { "title": "SecretActionType", "description": "The type of secret action.", "type": "string", "x-cli-option-name": "secret-action-type", "enum": [ "public_cert_action_validate_dns_challenge", "private_cert_action_revoke_certificate" ] }, "SecretVersionActionType": { "title": "SecretVersionActionType", "description": "The type of secret version action.", "type": "string", "x-cli-option-name": "secret-version-action-type", "enum": [ "private_cert_action_revoke_certificate" ] }, "ConfigurationActionType": { "title": "ConfigurationActionType", "description": "The type of configuration action.", "type": "string", "enum": [ "private_cert_configuration_action_rotate_crl", "private_cert_configuration_action_sign_intermediate", "private_cert_configuration_action_sign_csr", "private_cert_configuration_action_set_signed", "private_cert_configuration_action_revoke_ca_certificate", "private_cert_configuration_action_rotate_intermediate" ] }, "SecretName": { "title": "SecretName", "description": "A human-readable name to assign to your secret.\n\nTo protect your privacy, do not use personal data, such as your name or location, as a name for your secret.", "x-cli-description": "A human-readable name to assign to your secret.", "type": "string", "pattern": "^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$", "minLength": 2, "maxLength": 256, "example": "my-secret-example" }, "SecretNameRO": { "title": "SecretNameRO", "description": "The human-readable name of your secret.", "type": "string", "readOnly": true, "pattern": "^\\w(([\\w-.]+)?\\w)?$", "minLength": 2, "maxLength": 256, "example": "my-secret" }, "SecretNameV1Compatible": { "title": "SecretName", "description": "The human-readable name of your secret.", "type": "string", "pattern": "^\\w(([\\w-.]+)?\\w)?$", "minLength": 2, "maxLength": 256, "example": "my-secret" }, "SecretDescription": { "title": "SecretDescription", "description": "An extended description of your secret.\n\nTo protect your privacy, do not use personal data, such as your name or location, as a description for your\nsecret group.", "type": "string", "x-cli-description": "An extended description of your secret.", "pattern": "(.*?)", "minLength": 0, "maxLength": 1024, "example": "Extended description for this secret." }, "SecretVersionDownloaded": { "title": "SecretVersionDownloaded", "description": "This field indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.", "type": "boolean", "readOnly": true }, "SecretState": { "type": "integer", "format": "int32", "description": "The secret state that is based on `NIST SP 800-57`. States are integers and correspond to the `Pre-activation = 0`, `Active = 1`, `Suspended = 2`, `Deactivated = 3`, and `Destroyed = 5` values.", "readOnly": true, "minimum": 0, "maximum": 5, "enum": [ 0, 1, 2, 3, 5 ] }, "SecretStateDescription": { "type": "string", "description": "A text representation of the secret state.", "enum": [ "pre_activation", "active", "suspended", "deactivated", "destroyed" ], "example": "active", "readOnly": true }, "Label": { "title": "Label", "description": "Label that you can use to search for secrets in your instance.\n\nLabel can be between 2-64 characters, including spaces.\n\nTo protect your privacy, do not use personal data, such as your name or location, as a label for your secret.", "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 64, "example": "my-label" }, "LabelCollection": { "title": "LabelCollection", "description": "Labels that you can use to search secrets in your instance. Only 30 labels can be created.\n\nLabel can be between 2-64 characters, including spaces.\n\nTo protect your privacy, do not use personal data, such as your name or location, as a label for your secret.", "type": "array", "x-cli-description": "Labels that you can use to search secrets in your instance.", "uniqueItems": true, "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/Label" } }, "ReferencedBy": { "title": "ReferencedBy", "description": "The list of configurations that have a reference to the secret.", "readOnly": true, "type": "array", "x-cli-description": "Configurations that have a reference to the secret.", "uniqueItems": true, "minItems": 0, "maxItems": 50, "items": { "$ref": "#/components/schemas/ConfigurationName" } }, "Ttl": { "title": "TTL", "description": "The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types: iam_credentials, service_credentials, custom_credentials.\nThe TTL defines how long generated credentials remain valid. The value can be either an integer that specifies the number of seconds, or the string \nrepresentation of a duration, such as `1440m` or `24h`.\nFor the iam_credentials secret type, the TTL field is mandatory. The minimum duration is 1 minute. The maximum is 90 days.\nFor the service_credentials secret type, the TTL field is optional. If it is set the minimum duration is 1 day. The maximum is 90 days. By default, the TTL is set to 0. After the TTL is modified, it will be applied only on the next secret rotation.\nFor the custom_credentials secret type, the TTL field is optional. The minimum duration is 1 day. The maximum is 90 days.", "type": "string", "x-cli-description": "The time-to-live (TTL) or lease duration to assign to credentials that are generated. Supported secret types: iam_credentials, service_credentials, custom_credentials.", "pattern": "^[0-9]+[s,m,h,d]{0,1}$", "minLength": 1, "maxLength": 10, "example": "1d" }, "TaskTimeout": { "title": "TaskTimeout", "description": "Specifies the maximum allowed time for a Code Engine task to be completed. After this time elapses, the task state will changed to failed.\nThe minimum value is 5 minutes and the maximum value is 24 hours. Default task time out is 10 minutes. \nThe value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `10m` or `2h`.", "type": "string", "x-cli-description": "Specifies the maximum allowed time for a Code Engine task to be completed. After this time elapses, the task state will changed to failed. The minimum value is 5 minutes and the maximum value is 24 hours. Default task time out is 10 minutes. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as `10m` or `2h`.", "x-cli-option-name": "configuration-task-timeout", "pattern": "^[0-9]+[s,m,h,d]{0,1}$", "minLength": 1, "maxLength": 6, "example": "10m" }, "ApiKeyIAMCredentialsSecretRO": { "title": "ApiKey", "description": "The API key that is generated for this secret.\n\nAfter the secret reaches the end of its lease, the API key is deleted automatically. See the `time-to-live` field to understand the duration of the lease.\nIf you want to continue to use the same API key for future read operations, see the `reuse_api_key` field.", "x-terraform-sensitive": true, "type": "string", "readOnly": true, "pattern": "^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$", "minLength": 5, "maxLength": 60 }, "ApiKeyServiceCredentialsSecretRO": { "title": "ApiKey", "description": "The API key that is generated for this secret.\n\nAfter the secret reaches the end of its lease, the API key is deleted automatically. See the `time-to-live` field to understand the duration of the lease.", "x-terraform-sensitive": true, "type": "string", "readOnly": true, "pattern": "^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$", "minLength": 5, "maxLength": 60 }, "ApiKeyConfigurationRO": { "title": "ApiKey", "description": "An IBM Cloud API key that can create and manage service IDs.\nThe API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. \nFor more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).", "x-terraform-sensitive": true, "type": "string", "readOnly": true, "pattern": "^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$", "minLength": 5, "maxLength": 60 }, "ApiKeyConfiguration": { "title": "ApiKey", "description": "An IBM Cloud API key that can create and manage service IDs.\nThe API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. \nFor more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-configure-iam-engine).", "x-terraform-sensitive": true, "type": "string", "pattern": "^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$", "minLength": 5, "maxLength": 60 }, "ApiKeyId": { "title": "ApiKeyId", "description": "The ID of the API key that is generated for this secret.", "type": "string", "minLength": 0, "maxLength": 128, "readOnly": true }, "AccessGroup": { "title": "AccessGroup", "description": "The access groups that define the capabilities of the service ID and API key that are generated for an\n`iam_credentials` secret. If you prefer to use an existing service ID that is already assigned the access\npolicies that you require, you can omit this parameter and use the `service_id` field instead.\n\n**Tip:** To list the access groups that are available in an account, you can use the [IAM Access Groups\nAPI](https://cloud.ibm.com/apidocs/iam-access-groups#list-access-groups). To find the ID of an access\ngroup in the console, go to **Manage > Access (IAM) > Access groups**. Select the access group to\ninspect, and click **Details** to view its ID.", "type": "string", "pattern": "^AccessGroupId-[a-z0-9-]+[a-z0-9]$", "minLength": 50, "maxLength": 50, "example": "AccessGroupId-45884031-54be-4dd7-86ff-112511e92699" }, "AccessGroupCollection": { "title": "AccessGroupCollection", "description": "Access Groups that you can use for an `iam_credentials` secret.\n\nUp to 10 Access Groups can be used for each secret.", "type": "array", "x-cli-option-name": "iam-credentials-access-groups", "x-cli-description": "Access Groups that you can use for an `iam_credentials` secret.", "uniqueItems": true, "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/AccessGroup" }, "x-terraform-force-new": true }, "ServiceId": { "title": "ServiceId", "description": "The service ID under which the API key (see the `api_key` field) is created.\n\nIf you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation,\nand adds it to the access groups that you assign.\n\nOptionally, you can use this field to provide your own service ID if you prefer to manage its access\ndirectly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a\nservice ID, do not include the `access_groups` parameter.", "type": "string", "x-cli-option-name": "iam-credentials-service-id", "x-cli-description": "The service ID under which the API key is created.", "pattern": "^ServiceId-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 46, "maxLength": 46, "x-terraform-force-new": true, "example": "ServiceId-bb4ccc31-bd31-493a-bb58-52ec399800be" }, "AccountId": { "title": "AccountId", "description": "The ID of the account in which the IAM credentials are created. Use this field only if the target account is not the same as the account of the Secrets Manager instance. Otherwise, the field can be omitted.", "type": "string", "x-cli-option-name": "iam-credentials-account-id", "x-cli-description": "The ID of the account in which the IAM credentials are created.", "pattern": "^[a-z0-9]*$", "minLength": 32, "maxLength": 32, "x-terraform-force-new": true, "example": "708d4dc20986423e79bb8512f81b7f92" }, "ServiceIdIsStatic": { "title": "ServiceIdIsStatic", "description": "Indicates whether an `iam_credentials` secret was created with a static service ID.\n\nIf it is set to `true`, the service ID for the secret was provided by the user at secret creation. If it is set to `false`, the\nservice ID was generated by Secrets Manager.", "type": "boolean", "readOnly": true }, "ReuseApiKey": { "title": "ReuseApiKey", "description": "(IAM credentials) This parameter indicates whether to reuse the service ID and API key for future read operations.\n\nIf it is set to `true`, the service reuses the current credentials. If it is set to `false`, a new service\nID and API key are generated each time that the secret is read or accessed.", "type": "boolean", "x-cli-option-name": "iam-credentials-reuse-apikey", "x-cli-description": "This parameter indicates whether to reuse the service ID and API key for future read operations." }, "NextRotationDate": { "title": "NextRotationDate", "description": "The date that the secret is scheduled for automatic rotation.\n\nThe service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that can be auto-rotated and an existing rotation policy.", "type": "string", "format": "date-time", "minLength": 0, "maxLength": 128, "nullable": true, "readOnly": true }, "UserCredentialsUsername": { "title": "UserCredentialsUsername", "description": "The username that is assigned to an `username_password` secret.", "type": "string", "x-terraform-force-new": true, "x-cli-option-name": "username-password-username", "pattern": "[A-Za-z0-9+-=.]*", "minLength": 2, "maxLength": 64 }, "UserCredentialsPassword": { "title": "UserCredentialsPassword", "description": "The password that is assigned to an `username_password` secret. If you omit this parameter, Secrets Manager \ngenerates a new random password for your secret.", "type": "string", "x-terraform-force-new": true, "x-cli-option-name": "username-password-password", "pattern": ".{6,256}", "minLength": 6, "maxLength": 256 }, "UserCredentialsPasswordRO": { "title": "UserCredentialsPassword", "description": "The password that is assigned to an `username_password` secret.", "type": "string", "minLength": 6, "maxLength": 256 }, "SecretVersionsTotal": { "description": "The number of versions of your secret.", "type": "integer", "format": "int32", "minimum": 0, "maximum": 50 }, "SecretLocksTotal": { "description": "The number of locks of the secret.", "readOnly": true, "type": "integer", "format": "int32", "minimum": 0, "maximum": 1000 }, "SecretTasksTotal": { "description": "The number of tasks that were created for this secret.", "readOnly": true, "type": "integer", "format": "int32", "minimum": 0, "maximum": 1000 }, "SecretQueuedTasks": { "description": "Number of queued tasks for this secret.", "readOnly": true, "type": "integer", "format": "int32", "minimum": 0, "maximum": 1000 }, "LastRotationFailed": { "description": "Indicates if the last rotation (automatic or manual) for the secret failed.", "readOnly": true, "type": "boolean" }, "CustomCredentialsConfigurationName": { "title": "CustomCredentialsConfigurationName", "x-cli-option-name": "custom-credentials-configuration", "x-cli-description": "The name of the custom credentials configuration.", "description": "The name of the custom credentials configuration.", "type": "string", "pattern": "^[a-zA-Z0-9]([-a-zA-Z0-9\\-_\\.]*)?$", "minLength": 2, "maxLength": 128 }, "Certificate": { "title": "Certificate", "description": "Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline\ncharacters.", "x-cli-option-name": "imported-cert-certificate", "x-cli-description": "The PEM-encoded contents of your certificate.", "type": "string", "x-terraform-force-new": true, "x-terraform-sensitive": true, "x-terraform-computed": true, "minLength": 50, "maxLength": 100000, "pattern": "(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)" }, "CertificateRO": { "title": "Certificate", "description": "Your PEM-encoded certificate. The data must be formatted on a single line with embedded newline\ncharacters.", "x-cli-description": "The PEM-encoded contents of your certificate.", "type": "string", "minLength": 50, "maxLength": 100000 }, "CertificateValidity": { "title": "CertificateValidity", "description": "The date and time that the certificate validity period begins and ends.", "x-cli-description": "The date and time that the certificate validity period begins and ends.", "additionalProperties": false, "minProperties": 2, "maxProperties": 2, "required": [ "not_before", "not_after" ], "properties": { "not_before": { "$ref": "#/components/schemas/DateTime" }, "not_after": { "$ref": "#/components/schemas/DateTime" } } }, "CertificatePrivateKey": { "title": "CertificatePrivateKey", "description": "The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line with\nembedded newline characters.", "x-cli-option-name": "imported-cert-private-key", "x-cli-description": "(Optional) The PEM-encoded private key to associate with the certificate.", "type": "string", "x-terraform-force-new": true, "x-terraform-sensitive": true, "x-terraform-computed": true, "minLength": 50, "maxLength": 100000, "pattern": "(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)" }, "CertificatePrivateKeyRO": { "title": "CertificatePrivateKey", "description": "The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line with\nembedded newline characters.", "x-cli-description": "(Optional) The PEM-encoded private key to associate with the certificate.", "type": "string", "minLength": 50, "maxLength": 100000 }, "ImportedCertificateManagedCsrPrivateKey": { "title": "CertificatePrivateKey", "description": "The PEM-encoded private key that is associated with the certificate. The data must be formatted on a single line with\nembedded newline characters.", "x-cli-description": "The PEM-encoded private key to associate with the certificate.", "type": "string", "minLength": 10, "maxLength": 100000, "pattern": "^.*?$" }, "ImportedCertificateCSR": { "description": "The certificate signing request.", "type": "string", "x-cli-option-name": "csr", "pattern": "^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$", "minLength": 2, "maxLength": 4096 }, "CertificateIntermediate": { "title": "CertificateIntermediate", "description": "The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on a\nsingle line with embedded newline characters.", "x-cli-option-name": "imported-cert-intermediate", "x-cli-description": "(Optional) The PEM-encoded intermediate certificate that is associated with the root certificate.", "type": "string", "x-terraform-force-new": true, "x-terraform-sensitive": true, "x-terraform-computed": true, "minLength": 50, "maxLength": 100000, "pattern": "(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)" }, "CertificateIntermediateRO": { "title": "CertificateIntermediate", "description": "The PEM-encoded intermediate certificate that is associated with the root certificate. The data must be formatted on a\nsingle line with embedded newline characters.", "x-cli-description": "(Optional) The PEM-encoded intermediate certificate that is associated with the root certificate.", "type": "string", "minLength": 50, "maxLength": 100000 }, "ImportedCertificateManagedCsr": { "title": "Managed CSR", "description": "The data specified to create the CSR and the private key.", "x-cli-option-name": "imported-cert-managed-csr", "type": "object", "additionalProperties": false, "properties": { "ou": { "$ref": "#/components/schemas/CertificateOrganizationalUnitArray" }, "organization": { "$ref": "#/components/schemas/CertificateOrganizationArray" }, "country": { "$ref": "#/components/schemas/CertificateCountryArray" }, "locality": { "$ref": "#/components/schemas/CertificateLocalityArray" }, "province": { "$ref": "#/components/schemas/CertificateProvinceArray" }, "street_address": { "$ref": "#/components/schemas/CertificateStreetAddressArray" }, "postal_code": { "$ref": "#/components/schemas/CertificatePostalCodeArray" }, "require_cn": { "$ref": "#/components/schemas/CertificateRequireCn" }, "common_name": { "$ref": "#/components/schemas/CsrCommonName" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltNamesString" }, "ip_sans": { "$ref": "#/components/schemas/CertificateIpSansString" }, "uri_sans": { "$ref": "#/components/schemas/CertificateUriSansString" }, "other_sans": { "$ref": "#/components/schemas/CertificateOtherSansString" }, "exclude_cn_from_sans": { "$ref": "#/components/schemas/CertificateExcludeCnFromSans" }, "user_ids": { "$ref": "#/components/schemas/CertificateUserIdsString" }, "server_flag": { "$ref": "#/components/schemas/CertificateServerFlag" }, "client_flag": { "$ref": "#/components/schemas/CertificateClientFlag" }, "code_signing_flag": { "$ref": "#/components/schemas/CertificateCodeSigningFlag" }, "email_protection_flag": { "$ref": "#/components/schemas/CertificateEmailProtectionFlag" }, "key_type": { "$ref": "#/components/schemas/CertificatePrivateKeyType" }, "key_bits": { "$ref": "#/components/schemas/CertificatePrivateKeyBits" }, "key_usage": { "$ref": "#/components/schemas/CertificateKeyUsageString" }, "ext_key_usage": { "$ref": "#/components/schemas/CertificateExtKeyUsageString" }, "policy_identifiers": { "$ref": "#/components/schemas/CertificatePolicyIdentifiersString" }, "ext_key_usage_oids": { "$ref": "#/components/schemas/CertificateExtKeyUsageOidsString" }, "rotate_keys": { "$ref": "#/components/schemas/ImportedCertificateManagedCsrRotateKeys" } } }, "ImportedCertificateManagedCsrResponse": { "title": "Managed CSR", "description": "The data specified to create the CSR and the private key.", "x-cli-option-name": "imported-cert-managed-csr", "type": "object", "required": [ "ou", "organization", "country", "locality", "province", "street_address", "postal_code", "require_cn", "csr", "private_key", "exclude_cn_from_sans", "server_flag", "client_flag", "code_signing_flag", "email_protection_flag", "key_type", "key_bits" ], "properties": { "ou": { "$ref": "#/components/schemas/CertificateOrganizationalUnitArray" }, "organization": { "$ref": "#/components/schemas/CertificateOrganizationArray" }, "country": { "$ref": "#/components/schemas/CertificateCountryArray" }, "locality": { "$ref": "#/components/schemas/CertificateLocalityArray" }, "province": { "$ref": "#/components/schemas/CertificateProvinceArray" }, "street_address": { "$ref": "#/components/schemas/CertificateStreetAddressArray" }, "postal_code": { "$ref": "#/components/schemas/CertificatePostalCodeArray" }, "require_cn": { "$ref": "#/components/schemas/CertificateRequireCn" }, "common_name": { "$ref": "#/components/schemas/CsrCommonName" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltNamesString" }, "ip_sans": { "$ref": "#/components/schemas/CertificateIpSansString" }, "uri_sans": { "$ref": "#/components/schemas/CertificateUriSansString" }, "other_sans": { "$ref": "#/components/schemas/CertificateOtherSansString" }, "exclude_cn_from_sans": { "$ref": "#/components/schemas/CertificateExcludeCnFromSans" }, "user_ids": { "$ref": "#/components/schemas/CertificateUserIdsString" }, "server_flag": { "$ref": "#/components/schemas/CertificateServerFlag" }, "client_flag": { "$ref": "#/components/schemas/CertificateClientFlag" }, "code_signing_flag": { "$ref": "#/components/schemas/CertificateCodeSigningFlag" }, "email_protection_flag": { "$ref": "#/components/schemas/CertificateEmailProtectionFlag" }, "key_type": { "$ref": "#/components/schemas/CertificatePrivateKeyType" }, "key_bits": { "$ref": "#/components/schemas/CertificatePrivateKeyBits" }, "key_usage": { "$ref": "#/components/schemas/CertificateKeyUsageString" }, "ext_key_usage": { "$ref": "#/components/schemas/CertificateExtKeyUsageString" }, "policy_identifiers": { "$ref": "#/components/schemas/CertificatePolicyIdentifiersString" }, "ext_key_usage_oids": { "$ref": "#/components/schemas/CertificateExtKeyUsageOidsString" }, "rotate_keys": { "$ref": "#/components/schemas/ImportedCertificateManagedCsrRotateKeys" }, "csr": { "$ref": "#/components/schemas/ImportedCertificateCSR" }, "private_key": { "$ref": "#/components/schemas/ImportedCertificateManagedCsrPrivateKey" } } }, "CertificateOrganizationalUnitArray": { "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", "type": "array", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 128 }, "x-cli-option-name": "subject-organizational-unit" }, "CertificateOrganizationArray": { "description": "The Organization (O) values to define in the subject field of the resulting certificate.", "type": "array", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 128 }, "x-cli-option-name": "subject-organization" }, "CertificateCountryArray": { "description": "The Country (C) values to define in the subject field of the resulting certificate.", "x-cli-option-name": "subject-country", "type": "array", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 128 } }, "CertificateLocalityArray": { "description": "The Locality (L) values to define in the subject field of the resulting certificate.", "x-cli-option-name": "subject-locality", "type": "array", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 64 } }, "CertificateProvinceArray": { "description": "The Province (ST) values to define in the subject field of the resulting certificate.", "x-cli-option-name": "subject-province", "type": "array", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 64 } }, "CertificateStreetAddressArray": { "description": "The street address values to define in the subject field of the resulting certificate.", "x-cli-option-name": "subject-street-address", "type": "array", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 256 } }, "CertificatePostalCodeArray": { "description": "The postal code values to define in the subject field of the resulting certificate.", "x-cli-option-name": "subject-postal-code", "type": "array", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 64 } }, "CertificateRequireCn": { "title": "CertificateRequireCommonName", "type": "boolean", "description": "If set to false, makes the common_name field optional while generating a certificate." }, "CertificateIssuer": { "title": "CertificateIssuer", "description": "The distinguished name that identifies the entity that signed and issued the certificate.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "private-cert-issuer", "pattern": "(.*?)", "minLength": 2, "maxLength": 128, "example": "Lets Encrypt" }, "CertificateIssuanceInfo": { "title": "CertificateIssuanceInfo", "type": "object", "readOnly": true, "description": "Issuance information that is associated with your certificate.", "required": [ "ordered_on", "state", "state_description" ], "properties": { "auto_rotated": { "type": "boolean", "readOnly": true, "description": "This parameter indicates whether the issued certificate is configured with an automatic rotation policy." }, "challenges": { "$ref": "#/components/schemas/Challenges" }, "dns_challenge_validation_time": { "description": "The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows `RFC 3339`.", "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "minLength": 0, "maxLength": 35, "example": "2022-10-22T23:20:50.52Z" }, "error_code": { "description": "A code that identifies an issuance error.\n\nThis field, along with `error_message`, is returned when Secrets Manager successfully processes your request,\nbut the certificate authority is unable to issue a certificate.", "type": "string", "minLength": 0, "maxLength": 256, "readOnly": true, "nullable": true }, "error_message": { "description": "A human-readable message that provides details about the issuance error.", "type": "string", "readOnly": true, "nullable": true, "minLength": 0, "maxLength": 4096 }, "ordered_on": { "description": "The date when the certificate is ordered. The date format follows `RFC 3339`.", "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "minLength": 0, "maxLength": 128, "example": "2022-10-12T23:20:50.52Z" }, "state": { "$ref": "#/components/schemas/SecretState" }, "state_description": { "$ref": "#/components/schemas/SecretStateDescription" } } }, "Challenges": { "type": "array", "minItems": 1, "maxItems": 100, "readOnly": true, "description": "The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.", "items": { "$ref": "#/components/schemas/ChallengeResource" } }, "ChallengeResource": { "description": "Properties that describe a challenge.", "type": "object", "properties": { "domain": { "description": "The challenge domain.", "type": "string", "readOnly": true, "minLength": 0, "maxLength": 256, "example": "example.com" }, "expiration": { "description": "The challenge expiration date. The date format follows `RFC 3339`.", "type": "string", "format": "date-time", "minLength": 0, "maxLength": 35, "readOnly": true, "example": "2022-09-20T06:21:36Z" }, "status": { "description": "The challenge status.", "type": "string", "minLength": 0, "maxLength": 128, "readOnly": true, "example": "pending" }, "txt_record_name": { "description": "The TXT record name.", "type": "string", "readOnly": true, "minLength": 0, "maxLength": 256, "example": "_acme-challenge.example.com." }, "txt_record_value": { "description": "The TXT record value.", "type": "string", "readOnly": true, "minLength": 0, "maxLength": 256, "example": "TA6J7fFYrwP3Jg-S_IAQSj2Ydqfw4Ycm4sMwlzuCcxk" } } }, "CertificateIntermediateIncluded": { "title": "CertificateIntermediateIncluded", "description": "Indicates whether the certificate was imported with an associated intermediate certificate.", "type": "boolean" }, "CertificatePrivateKeyIncluded": { "title": "CertificatePrivateKeyIncluded", "description": "Indicates whether the certificate was imported with an associated private key.", "type": "boolean" }, "CertificateBundleCa": { "title": "CertificateBundleCa", "description": "This field indicates whether your issued certificate is bundled with intermediate certificates.\nSet to `false` for the certificate file to contain only the issued certificate.", "x-terraform-force-new": true, "x-cli-option-name": "public-cert-bundle-ca", "type": "boolean", "default": true }, "CertificateCommonName": { "title": "CertificateCommonName", "description": "The Common Name (CN) represents the server name protected by the SSL certificate.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "certificate-common-name", "minLength": 4, "maxLength": 64, "pattern": "^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$", "example": "example.com" }, "CsrCommonName": { "title": "CsrCommonName", "description": "The Common Name (CN) represents the server name protected by the SSL certificate.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "csr-common-name", "minLength": 0, "maxLength": 64, "pattern": "^$|^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$", "example": "example.com" }, "CertificateAltName": { "title": "CertificateAltName", "description": "With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL certificate.", "type": "array", "x-cli-option-name": "certificate-alt-names", "minItems": 0, "maxItems": 99, "uniqueItems": true, "items": { "type": "string", "pattern": "^(.*?)$", "minLength": 1, "maxLength": 256 }, "x-terraform-force-new": true, "x-terraform-computed": true, "example": [ "s1.example.com", "*.s2.example.com" ] }, "CertificateAltNamesString": { "title": "CertificateAltNames", "description": "With the Subject Alternative Name field, you can specify additional hostnames to be protected by a single SSL certificate.", "x-cli-option-name": "certificate-alt-names", "type": "string", "pattern": "^(.*?)$", "minLength": 0, "maxLength": 2048, "example": "alt-name-1,alt-name-2" }, "CertificateIpSansString": { "description": "The IP Subject Alternative Names to define for the certificate, in a comma-delimited list.", "type": "string", "x-cli-option-name": "certificate-ip-sans", "pattern": "^.*?$", "minLength": 0, "maxLength": 2048, "example": "1.1.1.1,2.2.2.2" }, "CertificateUriSansString": { "description": "The URI Subject Alternative Names to define for the certificate, in a comma-delimited list.", "type": "string", "x-cli-option-name": "certificate-uri-sans", "pattern": "^.*?$", "minLength": 0, "maxLength": 2048 }, "CertificateOtherSansString": { "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate, in a comma-delimited list.\n\nThe format is the same as OpenSSL: `::` where the current valid type is `UTF8`.", "x-cli-option-name": "certificate-other-sans", "x-cli-description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names to define for the certificate.", "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 2048, "example": "2.5.4.5;UTF8:*.example.com" }, "CertificateExcludeCnFromSans": { "description": "This parameter controls whether the common name is excluded from Subject Alternative Names (SANs).\n\nIf the common name is set to `true`, it is not included in DNS, or email SANs if they apply. This field can be useful\nif the common name is a human-readable identifier, instead of a hostname or an email address.", "type": "boolean", "x-cli-option-name": "certificate-exclude-cn-from-sans", "x-cli-description": "This parameter controls whether the common name is excluded from Subject Alternative Names (SANs)." }, "CertificateUserIdsString": { "description": "Specifies the list of requested User ID (OID 0.9.2342.19200300.100.1.1) Subject values to be placed on the signed certificate.", "x-cli-option-name": "certificate-user-ids", "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 2048, "example": "user-1,user-2" }, "CertificateServerFlag": { "type": "boolean", "description": "This field indicates whether certificate is flagged for server use.", "x-cli-option-name": "certificate-server-flag" }, "CertificateClientFlag": { "type": "boolean", "description": "This field indicates whether certificate is flagged for client use.", "x-cli-option-name": "certificate-client-flag" }, "CertificateCodeSigningFlag": { "type": "boolean", "description": "This field indicates whether certificate is flagged for code signing use.", "x-cli-option-name": "certificate-code-signing-flag" }, "CertificateEmailProtectionFlag": { "type": "boolean", "description": "This field indicates whether certificate is flagged for email protection use.", "x-cli-option-name": "certificate-email-protection-flag" }, "CertificatePrivateKeyType": { "description": "The type of private key to generate.", "type": "string", "x-cli-option-name": "certificate-private-key-type", "enum": [ "rsa", "ec", "ed25519" ] }, "CertificatePrivateKeyBits": { "description": "The number of bits to use to generate the private key.\n\nAllowable values for RSA keys are: `2048`, `3072`, `4096` and `8192`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`.\nThe default for RSA keys is `2048`. The default for EC keys is `256`. Ignored for ed25519 keys.", "type": "integer", "format": "int32", "x-cli-option-name": "certificate-private-key-bits", "x-cli-description": "The number of bits to use to generate the private key.", "minimum": 0, "maximum": 8192, "example": 4096 }, "CertificateKeyUsageString": { "description": "The allowed key usage constraint to define for certificate, in a comma-delimited list.\n\nYou can find valid values in the [Go x509 package documentation](https://pkg.go.dev/crypto/x509#KeyUsage).\nOmit the `KeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints,\nset this field to an empty string.", "x-cli-option-name": "certificate-key-usage", "x-cli-description": "The allowed key usage constraint to define for certificate.", "type": "string", "minLength": 0, "maxLength": 256, "example": "DigitalSignature,KeyAgreement,KeyEncipherment" }, "CertificateExtKeyUsageString": { "description": "The allowed extended key usage constraint on certificate, in a comma-delimited list.\n\nYou can find valid values in the [Go x509 package documentation](https://golang.org/pkg/crypto/x509/#ExtKeyUsage).\nOmit the `ExtKeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints,\nset this field to an empty string.", "x-cli-option-name": "certificate-ext-key-usage", "x-cli-description": "The allowed extended key usage constraint on certificate.", "type": "string", "minLength": 0, "maxLength": 256, "example": "ServerAuth,ClientAuth,EmailProtection" }, "CertificatePolicyIdentifiersString": { "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 2048, "description": "A comma-delimited list of policy Object Identifiers (OIDs).", "x-cli-option-name": "certificate-policy-identifiers" }, "CertificateExtKeyUsageOidsString": { "description": "A comma-delimited list of extended key usage Object Identifiers (OIDs).", "x-cli-option-name": "certificate-ext-key-usage-oids", "type": "string", "pattern": "^.*?$", "minLength": 0, "maxLength": 2048 }, "ImportedCertificateManagedCsrRotateKeys": { "type": "boolean", "description": "This field indicates whether the private key will be rotated.", "x-cli-option-name": "managed-csr-rotate-keys" }, "CertificateSerialNumber": { "title": "CertificateSerialNumber", "description": "The unique serial number that was assigned to a certificate by the issuing certificate authority.", "type": "string", "minLength": 2, "maxLength": 64, "example": "38:eb:01:a3:22:e9:de:55:24:56:9b:14:cb:e2:f3:e3:e2:fb:f5:18" }, "CertificateSigningAlgorithm": { "title": "CertificateSigningAlgorithm", "description": "The identifier for the cryptographic algorithm that is used by the issuing certificate authority to\nsign a certificate.", "type": "string", "minLength": 4, "maxLength": 64, "example": "SHA256-RSA" }, "CertificateKeyAlgorithm": { "title": "CertificateKeyAlgorithm", "description": "The identifier for the cryptographic algorithm that is used to generate the public key that is\nassociated with the certificate.\n\nThe algorithm that you select determines the encryption algorithm (`RSA` or `ECDSA`) and key size to be\nused to generate keys and sign certificates. For longer living certificates, it is recommended to use\nlonger keys to provide more encryption protection.\nAllowed values: `RSA2048`, `RSA4096`, `ECDSA256`, and `ECDSA384`", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "public-cert-key-algorithm", "x-cli-description": "The identifier for the cryptographic algorithm that is used to generate the public key that is associated with the certificate.", "pattern": "^(RSA2048|RSA4096|ECDSA256|ECDSA384)$", "minLength": 5, "maxLength": 8, "default": "RSA2048", "example": "RSA2048" }, "CertificateKeyAlgorithmRO": { "title": "CertificateKeyAlgorithmRO", "description": "The identifier for the cryptographic algorithm used to generate the public key that is\nassociated with the certificate.", "readOnly": true, "type": "string", "minLength": 2, "maxLength": 10, "example": "RSA2048" }, "SecretLocksMode": { "description": "- `remove_previous`: Removes any other locks with matching names if they are found in the previous version of the secret.\n- `remove_previous_and_delete`: Same as `remove_previous`, but also permanently deletes the data of the previous secret version if it doesn't have any locks. Not supported for custom credentials secret type.", "type": "string", "enum": [ "remove_previous", "remove_previous_and_delete" ] }, "SecretVersionAlias": { "description": "A human-readable alias that describes the secret version. 'Current' is used for version `n` and 'previous'\nis used for version `n-1`.", "type": "string", "enum": [ "current", "previous" ] }, "SecretsLockCollection": { "description": "A collection of secrets and their locks.", "type": "object", "x-terraform-datasource-name": "sm_secrets_locks", "x-terraform-datasource-operations": { "read": "list_secrets_locks" }, "required": [ "secrets_locks" ], "properties": { "secrets_locks": { "description": "A collection of secrets and their locks.", "type": "array", "items": { "$ref": "#/components/schemas/SecretLocks" }, "minItems": 0, "maxItems": 200 } } }, "SecretLocks": { "description": "Create locks response body containing a collection of locks that are attached to a secret.", "type": "object", "additionalProperties": false, "required": [ "secret_id", "secret_group_id", "versions", "secret_type" ], "properties": { "secret_id": { "$ref": "#/components/schemas/Uuid" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "secret_type": { "$ref": "#/components/schemas/SecretType" }, "secret_name": { "$ref": "#/components/schemas/SecretNameRO" }, "versions": { "description": "A collection of locks that are attached to a secret.", "type": "array", "minItems": 0, "maxItems": 2, "items": { "$ref": "#/components/schemas/SecretVersionLocks" } } } }, "SecretVersionLocks": { "type": "object", "additionalProperties": false, "required": [ "version_id", "version_alias", "locks" ], "properties": { "version_id": { "$ref": "#/components/schemas/Uuid" }, "version_alias": { "$ref": "#/components/schemas/SecretVersionAlias" }, "locks": { "description": "The names of all locks that are associated with this secret version.", "type": "array", "minItems": 0, "maxItems": 1000, "items": { "$ref": "#/components/schemas/SecretLockName" }, "example": [ "lock-example-1", "lock-example-2" ] }, "payload_available": { "$ref": "#/components/schemas/SecretVersionPayloadAvailable" } } }, "SecretLockName": { "description": "A human-readable name to assign to the lock. The lock name must be unique per secret version.\n\nTo protect your privacy, do not use personal data, such as your name or location, as a name for your secret lock.", "type": "string", "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_.]{1,63}$", "minLength": 2, "maxLength": 64, "example": "lock-example" }, "SecretLockDescription": { "description": "An extended description of the lock.\n\nTo protect your privacy, do not use personal data, such as your name or location, as a description for your\nsecret lock.", "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 1024 }, "SecretLockAttributes": { "description": "Optional information to associate with a lock, such as resources CRNs to be used by automation.", "type": "object", "nullable": true, "additionalProperties": true, "example": { "key": "value" } }, "SecretLockCollection": { "title": "SecretLockCollection", "description": "Properties that describe a collection of secret locks.", "type": "object", "required": [ "locks" ], "properties": { "locks": { "description": "A collection of secret locks.", "type": "array", "items": { "$ref": "#/components/schemas/SecretLock" }, "minItems": 0, "maxItems": 1000 } } }, "SecretVersionLocksCollection": { "title": "SecretVersionLocksCollection", "description": "Properties that describe a collection of secret version locks.", "type": "object", "required": [ "locks" ], "properties": { "locks": { "description": "A collection of secret version locks.", "type": "array", "items": { "$ref": "#/components/schemas/SecretLock" }, "minItems": 0, "maxItems": 1000 } } }, "SecretLock": { "allOf": [ { "$ref": "#/components/schemas/SecretLockPrototype" }, { "type": "object", "required": [ "created_at", "updated_at", "created_by", "secret_group_id", "secret_id", "secret_version_id", "secret_version_alias" ], "properties": { "created_at": { "$ref": "#/components/schemas/CreationDate" }, "updated_at": { "$ref": "#/components/schemas/UpdateAt" }, "created_by": { "$ref": "#/components/schemas/CreatedBy" }, "secret_group_id": { "$ref": "#/components/schemas/SecretGroupId" }, "secret_id": { "$ref": "#/components/schemas/Uuid" }, "secret_version_id": { "$ref": "#/components/schemas/Uuid" }, "secret_version_alias": { "$ref": "#/components/schemas/SecretVersionAlias" } } } ] }, "SecretLockPrototype": { "type": "object", "required": [ "name" ], "properties": { "name": { "$ref": "#/components/schemas/SecretLockName" }, "description": { "$ref": "#/components/schemas/SecretLockDescription" }, "attributes": { "$ref": "#/components/schemas/SecretLockAttributes" } } }, "SecretLockCollectionPrototype": { "description": "The request body to create secret locks.", "type": "object", "x-resource-name": "sm_secret_locks", "x-terraform-resource-name": "secret_locks", "x-terraform-resource-id": "locks", "x-terraform-resource-operations": { "create": "create_secret_locks", "read": "list_secret_locks", "delete": "delete_secret_locks", "update": "create_secret_locks" }, "x-terraform-datasource-name": "sm_secret_locks", "x-terraform-datasource-operations": { "read": "list_secret_locks" }, "required": [ "locks" ], "additionalProperties": false, "properties": { "locks": { "description": "The locks data to be attached to a secret version.", "type": "array", "minItems": 0, "maxItems": 1000, "items": { "$ref": "#/components/schemas/SecretLockPrototype" } } } }, "SecretLockDeleteItems": { "description": "The names of the secret locks to be deleted.", "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/SecretLockName" } }, "ConfigurationType": { "title": "ConfigurationType", "description": "The configuration type. Can be one of: iam_credentials_configuration, public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template, custom_credentials_configuration", "type": "string", "x-cli-option-name": "config-type", "x-cli-description": "The configuration type.", "enum": [ "public_cert_configuration_dns_cloud_internet_services", "public_cert_configuration_dns_classic_infrastructure", "public_cert_configuration_ca_lets_encrypt", "private_cert_configuration_root_ca", "private_cert_configuration_intermediate_ca", "private_cert_configuration_template", "iam_credentials_configuration", "custom_credentials_configuration" ] }, "ConfigurationName": { "title": "ConfigurationName", "description": "A human-readable unique name to assign to your configuration.\n\nTo protect your privacy, do not use personal data, such as your name or location, as an name for your secret.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "name", "x-cli-description": "A human-readable unique name to assign to your configuration.", "pattern": "^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$", "minLength": 2, "maxLength": 128, "example": "my-example-engine-config" }, "ConfigurationNameRO": { "title": "ConfigurationNameRO", "description": "The unique name of your configuration.", "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 128, "example": "my-secret-engine-config" }, "IntermediateCANameRO": { "title": "IntermediateCANameRO", "description": "The name of the intermediate certificate authority configuration.", "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 128, "example": "example-intermediate-CA" }, "DNSConfigurationName": { "title": "DNSConfigurationName", "description": "The name of the DNS provider configuration.", "type": "string", "x-cli-option-name": "public-cert-dns", "pattern": "(.*?)", "minLength": 2, "maxLength": 128, "example": "my-dns-config" }, "CAConfigurationName": { "title": "CAConfigurationName", "description": "The name of the certificate authority configuration.", "type": "string", "x-cli-option-name": "public-cert-ca", "pattern": "(.*?)", "minLength": 2, "maxLength": 128, "example": "my-ca-config" }, "CommonConfigurationMetadata": { "title": "CommonConfigurationMetadata", "x-child-schema-name": "CommonConfigurationMetadata", "description": "The common properties of the configuration metadata.", "required": [ "secret_type", "config_type", "name", "created_at", "created_by", "updated_at" ], "properties": { "config_type": { "$ref": "#/components/schemas/ConfigurationType" }, "name": { "$ref": "#/components/schemas/ConfigurationNameRO" }, "secret_type": { "$ref": "#/components/schemas/SecretType" }, "created_by": { "$ref": "#/components/schemas/CreatedBy" }, "created_at": { "$ref": "#/components/schemas/CreationDate" }, "updated_at": { "$ref": "#/components/schemas/UpdateAt" } } }, "ConfigurationPrototype": { "title": "ConfigurationPrototype", "x-child-schema-name": "ConfigurationPrototype", "description": "The details of your configuration.", "x-cli-description": "A JSON containing the required details for creating a configuration.", "oneOf": [ { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSCloudInternetServicesPrototype" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSClassicInfrastructurePrototype" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptPrototype" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationRootCAPrototype" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationIntermediateCAPrototype" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationTemplatePrototype" }, { "$ref": "#/components/schemas/IAMCredentialsConfigurationPrototype" }, { "$ref": "#/components/schemas/CustomCredentialsConfigurationPrototype" } ], "discriminator": { "propertyName": "config_type", "mapping": { "public_cert_configuration_dns_cloud_internet_services": "#/components/schemas/PublicCertificateConfigurationDNSCloudInternetServicesPrototype", "public_cert_configuration_dns_classic_infrastructure": "#/components/schemas/PublicCertificateConfigurationDNSClassicInfrastructurePrototype", "public_cert_configuration_ca_lets_encrypt": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptPrototype", "private_cert_configuration_root_ca": "#/components/schemas/PrivateCertificateConfigurationRootCAPrototype", "private_cert_configuration_intermediate_ca": "#/components/schemas/PrivateCertificateConfigurationIntermediateCAPrototype", "private_cert_configuration_template": "#/components/schemas/PrivateCertificateConfigurationTemplatePrototype", "iam_credentials_configuration": "#/components/schemas/IAMCredentialsConfigurationPrototype", "custom_credentials_configuration": "#/components/schemas/CustomCredentialsConfigurationPrototype" } } }, "PublicCertificateConfigurationCALetsEncryptPrototype": { "title": "PublicCertificateConfigurationCALetsEncryptPrototype", "x-child-schema-name": "PublicCertificateConfigurationCALetsEncryptPrototype", "description": "The properties of the Let's Encrypt CA configuration.", "type": "object", "additionalProperties": false, "required": [ "config_type", "name", "lets_encrypt_environment", "lets_encrypt_private_key" ], "properties": { "config_type": { "$ref": "#/components/schemas/ConfigurationType" }, "name": { "$ref": "#/components/schemas/ConfigurationName" }, "lets_encrypt_environment": { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptEnvironment" }, "lets_encrypt_private_key": { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptPrivateKey" }, "lets_encrypt_preferred_chain": { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptPreferredChain" } } }, "PublicCertificateConfigurationCALetsEncryptData": { "title": "PublicCertificateConfigurationCALetsEncryptData", "x-child-schema-name": "PublicCertificateConfigurationCALetsEncryptData", "description": "The data of the Let's Encrypt CA configuration.", "type": "object", "required": [ "lets_encrypt_private_key" ], "properties": { "lets_encrypt_private_key": { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptPrivateKey" } } }, "PublicCertificateConfigurationCALetsEncryptEnvironment": { "title": "PublicCertificateConfigurationCALetsEncryptEnvironment", "description": "The configuration of the Let's Encrypt CA environment.", "x-cli-option-name": "public-cert-lets-encrypt-environment", "type": "string", "enum": [ "production", "staging" ] }, "PublicCertificateConfigurationCALetsEncryptPrivateKey": { "title": "PublicCertificateConfigurationCALetsEncryptPrivateKey", "description": "The PEM-encoded private key of your Let's Encrypt account. The data must be formatted on a single line with\nembedded newline characters.", "x-terraform-sensitive": true, "x-cli-option-name": "public-cert-lets-encrypt-private-key", "x-cli-description": "The PEM-encoded private key of your Let's Encrypt account.", "type": "string", "minLength": 50, "maxLength": 100000, "pattern": "(^-----BEGIN PRIVATE KEY-----.*?)|(^-----BEGIN RSA PRIVATE KEY-----.*?)" }, "PublicCertificateConfigurationCALetsEncryptPreferredChain": { "title": "PublicCertificateConfigurationCALetsEncryptPreferredChain", "description": "This field supports only the chains that Let's Encrypt provides. Keep empty to use the default or supply a valid Let's Encrypt-provided value. For a list of supported chains, see: https://letsencrypt.org/certificates/.", "x-cli-option-name": "public-cert-lets-encrypt-preferred-chain", "x-cli-description": "The preferred chain with an issuer that matches this Subject Common Name.", "type": "string", "minLength": 2, "maxLength": 30, "pattern": "(.*?)" }, "PrivateCertificateConfigurationRootCAPrototype": { "description": "The configuration of the root certificate authority.", "x-child-schema-name": "PrivateCertificateConfigurationRootCAPrototype", "type": "object", "required": [ "config_type", "name", "max_ttl", "common_name" ], "additionalProperties": false, "properties": { "config_type": { "$ref": "#/components/schemas/ConfigurationType" }, "name": { "$ref": "#/components/schemas/ConfigurationName" }, "crypto_key": { "$ref": "#/components/schemas/PrivateCertificateCryptoKey" }, "max_ttl": { "$ref": "#/components/schemas/PrivateCertificateCAMaxTTL" }, "crl_expiry": { "$ref": "#/components/schemas/PrivateCertificateCRLExpiry" }, "crl_disable": { "$ref": "#/components/schemas/PrivateCertificateCRLDisabled" }, "crl_distribution_points_encoded": { "$ref": "#/components/schemas/PrivateCertificateCRLDistributionPointsEncoded" }, "issuing_certificates_urls_encoded": { "$ref": "#/components/schemas/PrivateCertificateIssuingCertificatesUrlsEncoded" }, "common_name": { "$ref": "#/components/schemas/PrivateCertificateCommonName" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "ip_sans": { "$ref": "#/components/schemas/PrivateCertificateIpSans" }, "uri_sans": { "$ref": "#/components/schemas/PrivateCertificateUriSans" }, "other_sans": { "$ref": "#/components/schemas/PrivateCertificateOtherSans" }, "ttl": { "$ref": "#/components/schemas/PrivateCertificateTemplateTTL" }, "format": { "$ref": "#/components/schemas/PrivateCertificateFormat" }, "private_key_format": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyFormat" }, "key_type": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyType" }, "key_bits": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyBits" }, "max_path_length": { "$ref": "#/components/schemas/PrivateCertificateMaxPathLength" }, "exclude_cn_from_sans": { "$ref": "#/components/schemas/PrivateCertificateExcludeCnFromSans" }, "permitted_dns_domains": { "$ref": "#/components/schemas/PrivateCertificatePermittedDnsDomains" }, "ou": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganizationalUnit" }, "organization": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganization" }, "country": { "$ref": "#/components/schemas/PrivateCertificateSubjectCountry" }, "locality": { "$ref": "#/components/schemas/PrivateCertificateSubjectLocality" }, "province": { "$ref": "#/components/schemas/PrivateCertificateSubjectProvince" }, "street_address": { "$ref": "#/components/schemas/PrivateCertificateSubjectStreetAddress" }, "postal_code": { "$ref": "#/components/schemas/PrivateCertificateSubjectPostalCode" }, "serial_number": { "$ref": "#/components/schemas/PrivateCertificateRequestedSerialNumber" } } }, "PrivateCertificateConfigurationRootCA": { "title": "PrivateCertificateConfigurationRootCA", "x-child-schema-name": "PrivateCertificateConfigurationRootCA", "description": "The root certificate authority .", "x-resource-name": "sm_private_certificate_configuration_root_ca", "x-terraform-resource-name": "configuration_private_certificate_root_CA", "x-terraform-resource-id": "name", "x-terraform-resource-operations": { "create": "create_configuration", "read": "get_configuration", "update": "update_configuration", "delete": "delete_configuration" }, "x-terraform-datasource-name": "sm_private_certificate_configuration_root_ca", "x-terraform-datasource-operations": { "read": "get_configuration" }, "allOf": [ { "$ref": "#/components/schemas/PrivateCertificateConfigurationRootCAMetadata" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationRootCAData" } ] }, "PrivateCertificateConfigurationRootCAMetadata": { "title": "PrivateCertificateConfigurationRootCAMetadata", "x-child-schema-name": "PrivateCertificateConfigurationRootCAMetadata", "description": "The configuration of the metadata properties of the root certificate authority.", "allOf": [ { "$ref": "#/components/schemas/CommonConfigurationMetadata" }, { "type": "object", "required": [ "common_name" ], "properties": { "common_name": { "$ref": "#/components/schemas/PrivateCertificateCommonName" }, "crl_distribution_points_encoded": { "$ref": "#/components/schemas/PrivateCertificateCRLDistributionPointsEncoded" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" }, "key_type": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyType" }, "key_bits": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyBits" }, "status": { "$ref": "#/components/schemas/PrivateCertificateCAStatus" }, "crypto_key": { "$ref": "#/components/schemas/PrivateCertificateCryptoKey" } } } ] }, "PrivateCertificateConfigurationRootCAData": { "description": "The configuration of the root certificate authority metadata.", "x-child-schema-name": "PrivateCertificateConfigurationRootCAData", "type": "object", "required": [ "max_ttl_seconds" ], "properties": { "max_ttl_seconds": { "$ref": "#/components/schemas/PrivateCertificateCAMaxTTLSeconds" }, "crl_expiry_seconds": { "$ref": "#/components/schemas/PrivateCertificateCRLExpirySeconds" }, "crl_disable": { "$ref": "#/components/schemas/PrivateCertificateCRLDisabled" }, "issuing_certificates_urls_encoded": { "$ref": "#/components/schemas/PrivateCertificateIssuingCertificatesUrlsEncoded" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "ip_sans": { "$ref": "#/components/schemas/PrivateCertificateIpSans" }, "uri_sans": { "$ref": "#/components/schemas/PrivateCertificateUriSans" }, "other_sans": { "$ref": "#/components/schemas/PrivateCertificateOtherSans" }, "ttl_seconds": { "$ref": "#/components/schemas/PrivateCertificateTemplateTTLSeconds" }, "format": { "$ref": "#/components/schemas/PrivateCertificateFormat" }, "private_key_format": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyFormat" }, "max_path_length": { "$ref": "#/components/schemas/PrivateCertificateMaxPathLength" }, "exclude_cn_from_sans": { "$ref": "#/components/schemas/PrivateCertificateExcludeCnFromSans" }, "permitted_dns_domains": { "$ref": "#/components/schemas/PrivateCertificatePermittedDnsDomains" }, "ou": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganizationalUnit" }, "organization": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganization" }, "country": { "$ref": "#/components/schemas/PrivateCertificateSubjectCountry" }, "locality": { "$ref": "#/components/schemas/PrivateCertificateSubjectLocality" }, "province": { "$ref": "#/components/schemas/PrivateCertificateSubjectProvince" }, "street_address": { "$ref": "#/components/schemas/PrivateCertificateSubjectStreetAddress" }, "postal_code": { "$ref": "#/components/schemas/PrivateCertificateSubjectPostalCode" }, "serial_number": { "$ref": "#/components/schemas/CertificateSerialNumber" }, "data": { "$ref": "#/components/schemas/PrivateCertificateCAData" } } }, "PrivateCertificateConfigurationRootCAPatch": { "title": "PrivateCertificateConfigurationRootCAPatch", "x-child-schema-name": "PrivateCertificateConfigurationRootCAPatch", "description": "The configuration of the metadata patch for the root certificate authority.", "type": "object", "additionalProperties": false, "properties": { "max_ttl": { "$ref": "#/components/schemas/PrivateCertificateCAMaxTTL" }, "crl_expiry": { "$ref": "#/components/schemas/PrivateCertificateCRLExpiry" }, "crl_disable": { "$ref": "#/components/schemas/PrivateCertificateCRLDisabled" }, "crl_distribution_points_encoded": { "$ref": "#/components/schemas/PrivateCertificateCRLDistributionPointsEncoded" }, "issuing_certificates_urls_encoded": { "$ref": "#/components/schemas/PrivateCertificateIssuingCertificatesUrlsEncoded" } } }, "PrivateCertificateCAData": { "title": "PrivateCertificateCAData", "x-child-schema-name": "PrivateCertificateCAData", "description": "The configuration data of your Private Certificate.", "type": "object", "anyOf": [ { "$ref": "#/components/schemas/PrivateCertificateConfigurationIntermediateCACSR" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationCACertificate" } ] }, "PrivateCertificateConfigurationIntermediateCAPrototype": { "description": "The configuration of the intermediate certificate authority.", "x-child-schema-name": "PrivateCertificateConfigurationIntermediateCAPrototype", "type": "object", "required": [ "config_type", "name", "max_ttl", "signing_method", "common_name" ], "additionalProperties": false, "properties": { "config_type": { "$ref": "#/components/schemas/ConfigurationType" }, "name": { "$ref": "#/components/schemas/ConfigurationName" }, "crypto_key": { "$ref": "#/components/schemas/PrivateCertificateCryptoKey" }, "max_ttl": { "$ref": "#/components/schemas/PrivateCertificateCAMaxTTL" }, "signing_method": { "$ref": "#/components/schemas/PrivateCertificateSigningMethod" }, "issuer": { "$ref": "#/components/schemas/CertificateIssuer" }, "crl_expiry": { "$ref": "#/components/schemas/PrivateCertificateCRLExpiry" }, "crl_disable": { "$ref": "#/components/schemas/PrivateCertificateCRLDisabled" }, "crl_distribution_points_encoded": { "$ref": "#/components/schemas/PrivateCertificateCRLDistributionPointsEncoded" }, "issuing_certificates_urls_encoded": { "$ref": "#/components/schemas/PrivateCertificateIssuingCertificatesUrlsEncoded" }, "common_name": { "$ref": "#/components/schemas/PrivateCertificateCommonName" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "ip_sans": { "$ref": "#/components/schemas/PrivateCertificateIpSans" }, "uri_sans": { "$ref": "#/components/schemas/PrivateCertificateUriSans" }, "other_sans": { "$ref": "#/components/schemas/PrivateCertificateOtherSans" }, "format": { "$ref": "#/components/schemas/PrivateCertificateFormat" }, "private_key_format": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyFormat" }, "key_type": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyType" }, "key_bits": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyBits" }, "exclude_cn_from_sans": { "$ref": "#/components/schemas/PrivateCertificateExcludeCnFromSans" }, "ou": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganizationalUnit" }, "organization": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganization" }, "country": { "$ref": "#/components/schemas/PrivateCertificateSubjectCountry" }, "locality": { "$ref": "#/components/schemas/PrivateCertificateSubjectLocality" }, "province": { "$ref": "#/components/schemas/PrivateCertificateSubjectProvince" }, "street_address": { "$ref": "#/components/schemas/PrivateCertificateSubjectStreetAddress" }, "postal_code": { "$ref": "#/components/schemas/PrivateCertificateSubjectPostalCode" }, "serial_number": { "$ref": "#/components/schemas/PrivateCertificateRequestedSerialNumber" } } }, "PrivateCertificateConfigurationIntermediateCA": { "title": "PrivateCertificateConfigurationIntermediateCA", "x-child-schema-name": "PrivateCertificateConfigurationIntermediateCA", "description": "The configuration of the root certificate authority.", "x-resource-name": "sm_private_certificate_configuration_intermediate_ca", "x-terraform-resource-name": "configuration_private_certificate_intermediate_CA", "x-terraform-resource-id": "name", "x-terraform-resource-operations": { "create": "create_configuration", "read": "get_configuration", "update": "update_configuration", "delete": "delete_configuration" }, "x-terraform-datasource-name": "sm_private_certificate_configuration_intermediate_ca", "x-terraform-datasource-operations": { "read": "get_configuration" }, "allOf": [ { "$ref": "#/components/schemas/PrivateCertificateConfigurationIntermediateCAMetadata" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationIntermediateCAData" } ] }, "PrivateCertificateConfigurationIntermediateCAMetadata": { "title": "PrivateCertificateConfigurationIntermediateCAMetadata", "x-child-schema-name": "PrivateCertificateConfigurationIntermediateCAMetadata", "description": "The configuration of the metadata properties of the intermediate certificate authority.", "allOf": [ { "$ref": "#/components/schemas/CommonConfigurationMetadata" }, { "type": "object", "required": [ "common_name", "signing_method" ], "properties": { "common_name": { "$ref": "#/components/schemas/PrivateCertificateCommonName" }, "crl_distribution_points_encoded": { "$ref": "#/components/schemas/PrivateCertificateCRLDistributionPointsEncoded" }, "expiration_date": { "$ref": "#/components/schemas/ExpirationDateRO" }, "issuer": { "$ref": "#/components/schemas/CertificateIssuer" }, "key_type": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyType" }, "key_bits": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyBits" }, "signing_method": { "$ref": "#/components/schemas/PrivateCertificateSigningMethod" }, "status": { "$ref": "#/components/schemas/PrivateCertificateCAStatus" }, "crypto_key": { "$ref": "#/components/schemas/PrivateCertificateCryptoKey" } } } ] }, "PrivateCertificateConfigurationIntermediateCAData": { "description": "The configuration of the intermediate certificate authority.", "x-child-schema-name": "PrivateCertificateConfigurationIntermediateCAData", "type": "object", "required": [ "max_ttl_seconds" ], "properties": { "max_ttl_seconds": { "$ref": "#/components/schemas/PrivateCertificateCAMaxTTLSeconds" }, "crl_expiry_seconds": { "$ref": "#/components/schemas/PrivateCertificateCRLExpirySeconds" }, "crl_disable": { "$ref": "#/components/schemas/PrivateCertificateCRLDisabled" }, "issuing_certificates_urls_encoded": { "$ref": "#/components/schemas/PrivateCertificateIssuingCertificatesUrlsEncoded" }, "alt_names": { "$ref": "#/components/schemas/CertificateAltName" }, "ip_sans": { "$ref": "#/components/schemas/PrivateCertificateIpSans" }, "uri_sans": { "$ref": "#/components/schemas/PrivateCertificateUriSans" }, "other_sans": { "$ref": "#/components/schemas/PrivateCertificateOtherSans" }, "format": { "$ref": "#/components/schemas/PrivateCertificateFormat" }, "private_key_format": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyFormat" }, "exclude_cn_from_sans": { "$ref": "#/components/schemas/PrivateCertificateExcludeCnFromSans" }, "ou": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganizationalUnit" }, "organization": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganization" }, "country": { "$ref": "#/components/schemas/PrivateCertificateSubjectCountry" }, "locality": { "$ref": "#/components/schemas/PrivateCertificateSubjectLocality" }, "province": { "$ref": "#/components/schemas/PrivateCertificateSubjectProvince" }, "street_address": { "$ref": "#/components/schemas/PrivateCertificateSubjectStreetAddress" }, "postal_code": { "$ref": "#/components/schemas/PrivateCertificateSubjectPostalCode" }, "serial_number": { "$ref": "#/components/schemas/CertificateSerialNumber" }, "data": { "$ref": "#/components/schemas/PrivateCertificateCAData" } } }, "PrivateCertificateConfigurationIntermediateCAPatch": { "description": "The configuration patch of the intermediate certificate authority.", "x-child-schema-name": "PrivateCertificateConfigurationIntermediateCAPatch", "type": "object", "additionalProperties": false, "properties": { "max_ttl": { "$ref": "#/components/schemas/PrivateCertificateCAMaxTTL" }, "crl_expiry": { "$ref": "#/components/schemas/PrivateCertificateCRLExpiry" }, "crl_disable": { "$ref": "#/components/schemas/PrivateCertificateCRLDisabled" }, "crl_distribution_points_encoded": { "$ref": "#/components/schemas/PrivateCertificateCRLDistributionPointsEncoded" }, "issuing_certificates_urls_encoded": { "$ref": "#/components/schemas/PrivateCertificateIssuingCertificatesUrlsEncoded" } } }, "PrivateCertificateConfigurationIntermediateCACSR": { "type": "object", "readOnly": true, "x-child-schema-name": "PrivateCertificateConfigurationIntermediateCACSR", "description": "The data that is associated with the intermediate certificate authority.", "properties": { "csr": { "$ref": "#/components/schemas/PrivateCertificateCSR" }, "private_key": { "$ref": "#/components/schemas/CertificatePrivateKey" }, "private_key_type": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyType" }, "expiration": { "$ref": "#/components/schemas/PrivateCertificateExpiration" } } }, "PrivateCertificateConfigurationTemplatePrototype": { "description": "Properties that describe a certificate template. You can use a certificate template to control the parameters that\nare applied to your issued private certificates. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-certificate-templates).", "x-child-schema-name": "PrivateCertificateConfigurationTemplatePrototype", "type": "object", "required": [ "config_type", "name", "certificate_authority" ], "additionalProperties": false, "properties": { "config_type": { "$ref": "#/components/schemas/ConfigurationType" }, "name": { "$ref": "#/components/schemas/ConfigurationName" }, "certificate_authority": { "$ref": "#/components/schemas/PrivateCertificateConfigurationIntermediateCAName" }, "allowed_secret_groups": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedSecretGroups" }, "max_ttl": { "$ref": "#/components/schemas/PrivateCertificateCAMaxTTL" }, "ttl": { "$ref": "#/components/schemas/PrivateCertificateTemplateTTL" }, "allow_localhost": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowLocalhost" }, "allowed_domains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedDomains" }, "allowed_domains_template": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedDomainsTemplate" }, "allow_bare_domains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowBareDomains" }, "allow_subdomains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowSubdomains" }, "allow_glob_domains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowGlobDomains" }, "allow_wildcard_certificates": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowWildCard" }, "allow_any_name": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowAnyName" }, "enforce_hostnames": { "$ref": "#/components/schemas/PrivateCertificateTemplateEnforceHostnames" }, "allow_ip_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowIpSans" }, "allowed_uri_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedUriSans" }, "allowed_other_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedOtherSans" }, "server_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateServerFlag" }, "client_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateClientFlag" }, "code_signing_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateCodeSigningFlag" }, "email_protection_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateEmailProtectionFlag" }, "key_type": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyType" }, "key_bits": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyBits" }, "key_usage": { "$ref": "#/components/schemas/PrivateCertificateTemplateKeyUsage" }, "ext_key_usage": { "$ref": "#/components/schemas/PrivateCertificateTemplateExtKeyUsage" }, "ext_key_usage_oids": { "$ref": "#/components/schemas/PrivateCertificateTemplateExtKeyUsageOids" }, "use_csr_common_name": { "$ref": "#/components/schemas/PrivateCertificateTemplateUseCSRCommonName" }, "use_csr_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateUseCSRSans" }, "ou": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganizationalUnit" }, "organization": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganization" }, "country": { "$ref": "#/components/schemas/PrivateCertificateSubjectCountry" }, "locality": { "$ref": "#/components/schemas/PrivateCertificateSubjectLocality" }, "province": { "$ref": "#/components/schemas/PrivateCertificateSubjectProvince" }, "street_address": { "$ref": "#/components/schemas/PrivateCertificateSubjectStreetAddress" }, "postal_code": { "$ref": "#/components/schemas/PrivateCertificateSubjectPostalCode" }, "serial_number": { "$ref": "#/components/schemas/PrivateCertificateTemplateSerialNumber" }, "require_cn": { "$ref": "#/components/schemas/PrivateCertificateTemplateRequireCN" }, "policy_identifiers": { "$ref": "#/components/schemas/PrivateCertificateTemplatePolicyIdentifiers" }, "basic_constraints_valid_for_non_ca": { "$ref": "#/components/schemas/PrivateCertificateTemplateBasicConstraintsValidForNonCA" }, "not_before_duration": { "$ref": "#/components/schemas/PrivateCertificateTemplateNotBeforeDuration" } } }, "PrivateCertificateConfigurationTemplate": { "title": "PrivateCertificateConfigurationTemplate", "x-child-schema-name": "PrivateCertificateConfigurationTemplate", "description": "The configuration of the private certificate template.", "x-resource-name": "sm_private_certificate_configuration_template", "x-terraform-resource-name": "configuration_private_certificate_template", "x-terraform-resource-id": "name", "x-terraform-resource-operations": { "create": "create_configuration", "read": "get_configuration", "update": "update_configuration", "delete": "delete_configuration" }, "x-terraform-datasource-name": "sm_private_certificate_configuration_template", "x-terraform-datasource-operations": { "read": "get_configuration" }, "allOf": [ { "$ref": "#/components/schemas/PrivateCertificateConfigurationTemplateMetadata" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationTemplateData" } ] }, "PrivateCertificateConfigurationTemplateMetadata": { "title": "PrivateCertificateConfigurationTemplateMetadata", "x-child-schema-name": "PrivateCertificateConfigurationTemplateMetadata", "description": "The metadata properties of the configuration of the private certificate template.", "allOf": [ { "$ref": "#/components/schemas/CommonConfigurationMetadata" }, { "type": "object", "required": [ "certificate_authority" ], "properties": { "certificate_authority": { "$ref": "#/components/schemas/PrivateCertificateConfigurationIntermediateCAName" } } } ] }, "PrivateCertificateConfigurationTemplateData": { "description": "Properties that describe a certificate template. You can use a certificate template to control the parameters that\nare applied to your issued private certificates. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-certificate-templates).", "x-child-schema-name": "PrivateCertificateTemplateData", "type": "object", "properties": { "allowed_secret_groups": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedSecretGroups" }, "max_ttl_seconds": { "$ref": "#/components/schemas/PrivateCertificateCAMaxTTLSeconds" }, "ttl_seconds": { "$ref": "#/components/schemas/PrivateCertificateTemplateTTLSeconds" }, "allow_localhost": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowLocalhost" }, "allowed_domains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedDomains" }, "allowed_domains_template": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedDomainsTemplate" }, "allow_bare_domains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowBareDomains" }, "allow_subdomains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowSubdomains" }, "allow_glob_domains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowGlobDomains" }, "allow_any_name": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowAnyName" }, "enforce_hostnames": { "$ref": "#/components/schemas/PrivateCertificateTemplateEnforceHostnames" }, "allow_ip_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowIpSans" }, "allowed_uri_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedUriSans" }, "allowed_other_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedOtherSans" }, "server_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateServerFlag" }, "client_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateClientFlag" }, "code_signing_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateCodeSigningFlag" }, "email_protection_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateEmailProtectionFlag" }, "key_type": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyType" }, "key_bits": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyBits" }, "key_usage": { "$ref": "#/components/schemas/PrivateCertificateTemplateKeyUsage" }, "ext_key_usage": { "$ref": "#/components/schemas/PrivateCertificateTemplateExtKeyUsage" }, "ext_key_usage_oids": { "$ref": "#/components/schemas/PrivateCertificateTemplateExtKeyUsageOids" }, "use_csr_common_name": { "$ref": "#/components/schemas/PrivateCertificateTemplateUseCSRCommonName" }, "use_csr_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateUseCSRSans" }, "ou": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganizationalUnit" }, "organization": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganization" }, "country": { "$ref": "#/components/schemas/PrivateCertificateSubjectCountry" }, "locality": { "$ref": "#/components/schemas/PrivateCertificateSubjectLocality" }, "province": { "$ref": "#/components/schemas/PrivateCertificateSubjectProvince" }, "street_address": { "$ref": "#/components/schemas/PrivateCertificateSubjectStreetAddress" }, "postal_code": { "$ref": "#/components/schemas/PrivateCertificateSubjectPostalCode" }, "serial_number": { "$ref": "#/components/schemas/PrivateCertificateTemplateSerialNumber" }, "require_cn": { "$ref": "#/components/schemas/PrivateCertificateTemplateRequireCN" }, "policy_identifiers": { "$ref": "#/components/schemas/PrivateCertificateTemplatePolicyIdentifiers" }, "basic_constraints_valid_for_non_ca": { "$ref": "#/components/schemas/PrivateCertificateTemplateBasicConstraintsValidForNonCA" }, "not_before_duration_seconds": { "$ref": "#/components/schemas/PrivateCertificateTemplateNotBeforeDurationSeconds" } } }, "PrivateCertificateConfigurationTemplatePatch": { "description": "Properties that describe a certificate template. You can use a certificate template to control the parameters that\nare applied to your issued private certificates. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-certificate-templates).", "x-child-schema-name": "PrivateCertificateConfigurationTemplatePatch", "type": "object", "additionalProperties": false, "properties": { "allowed_secret_groups": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedSecretGroups" }, "max_ttl": { "$ref": "#/components/schemas/PrivateCertificateCAMaxTTL" }, "ttl": { "$ref": "#/components/schemas/PrivateCertificateTemplateTTL" }, "allow_localhost": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowLocalhost" }, "allowed_domains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedDomains" }, "allowed_domains_template": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedDomainsTemplate" }, "allow_bare_domains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowBareDomains" }, "allow_subdomains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowSubdomains" }, "allow_glob_domains": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowGlobDomains" }, "allow_any_name": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowAnyName" }, "enforce_hostnames": { "$ref": "#/components/schemas/PrivateCertificateTemplateEnforceHostnames" }, "allow_ip_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowIpSans" }, "allowed_uri_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedUriSans" }, "allowed_other_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateAllowedOtherSans" }, "server_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateServerFlag" }, "client_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateClientFlag" }, "code_signing_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateCodeSigningFlag" }, "email_protection_flag": { "$ref": "#/components/schemas/PrivateCertificateTemplateEmailProtectionFlag" }, "key_type": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyType" }, "key_bits": { "$ref": "#/components/schemas/PrivateCertificatePrivateKeyBits" }, "key_usage": { "$ref": "#/components/schemas/PrivateCertificateTemplateKeyUsage" }, "ext_key_usage": { "$ref": "#/components/schemas/PrivateCertificateTemplateExtKeyUsage" }, "ext_key_usage_oids": { "$ref": "#/components/schemas/PrivateCertificateTemplateExtKeyUsageOids" }, "use_csr_common_name": { "$ref": "#/components/schemas/PrivateCertificateTemplateUseCSRCommonName" }, "use_csr_sans": { "$ref": "#/components/schemas/PrivateCertificateTemplateUseCSRSans" }, "ou": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganizationalUnit" }, "organization": { "$ref": "#/components/schemas/PrivateCertificateSubjectOrganization" }, "country": { "$ref": "#/components/schemas/PrivateCertificateSubjectCountry" }, "locality": { "$ref": "#/components/schemas/PrivateCertificateSubjectLocality" }, "province": { "$ref": "#/components/schemas/PrivateCertificateSubjectProvince" }, "street_address": { "$ref": "#/components/schemas/PrivateCertificateSubjectStreetAddress" }, "postal_code": { "$ref": "#/components/schemas/PrivateCertificateSubjectPostalCode" }, "serial_number": { "$ref": "#/components/schemas/PrivateCertificateTemplateSerialNumber" }, "require_cn": { "$ref": "#/components/schemas/PrivateCertificateTemplateRequireCN" }, "policy_identifiers": { "$ref": "#/components/schemas/PrivateCertificateTemplatePolicyIdentifiers" }, "basic_constraints_valid_for_non_ca": { "$ref": "#/components/schemas/PrivateCertificateTemplateBasicConstraintsValidForNonCA" }, "not_before_duration": { "$ref": "#/components/schemas/PrivateCertificateTemplateNotBeforeDuration" } } }, "PrivateCertificateConfigurationCACertificate": { "title": "PrivateCertificateConfigurationCACertificate", "x-child-schema-name": "PrivateCertificateConfigurationCACertificate", "type": "object", "readOnly": true, "description": "The data that is associated with the root certificate authority.", "required": [ "certificate" ], "properties": { "certificate": { "$ref": "#/components/schemas/Certificate" }, "issuing_ca": { "$ref": "#/components/schemas/PrivateCertificateIssuingCA" }, "ca_chain": { "$ref": "#/components/schemas/PrivateCertificateCAChain" }, "expiration": { "$ref": "#/components/schemas/PrivateCertificateExpiration" } } }, "PrivateCertificateCryptoProvider": { "title": "PrivateCertificateCryptoProvider", "description": "The data that is associated with a cryptographic provider.", "oneOf": [ { "$ref": "#/components/schemas/PrivateCertificateCryptoProviderHPCS" } ], "discriminator": { "propertyName": "type", "mapping": { "hyper_protect_crypto_services": "#/components/schemas/PrivateCertificateCryptoProviderHPCS" } } }, "PrivateCertificateCryptoProviderHPCS": { "title": "PrivateCertificateCryptoProviderHPCS", "type": "object", "additionalProperties": false, "description": "The data that is associated with Hyper Protect Crypto Services as the cryptographic provider.", "required": [ "type", "instance_crn", "pin_iam_credentials_secret_id", "private_keystore_id" ], "properties": { "type": { "$ref": "#/components/schemas/PrivateCertificateCryptoProviderType" }, "instance_crn": { "$ref": "#/components/schemas/PrivateCertificateCryptoProviderInstanceCrn" }, "pin_iam_credentials_secret_id": { "$ref": "#/components/schemas/PrivateCertificateCryptoProviderPinIamCredentialsSecretId" }, "private_keystore_id": { "$ref": "#/components/schemas/PrivateCertificateCryptoProviderPrivateKeystoreId" } } }, "PrivateCertificateCryptoKey": { "title": "PrivateCertificateCryptoKey", "description": "The data that is associated with a cryptographic key.", "x-cli-option-name": "private-cert-crypto-key", "x-cli-description": "The data that is associated with a cryptographic key in JSON format.", "type": "object", "additionalProperties": false, "required": [ "provider" ], "properties": { "id": { "$ref": "#/components/schemas/PrivateCertificateCryptoKeyId" }, "label": { "$ref": "#/components/schemas/PrivateCertificateCryptoKeyLabel" }, "allow_generate_key": { "$ref": "#/components/schemas/PrivateCertificateCryptoKeyAllowGenerateKey" }, "provider": { "$ref": "#/components/schemas/PrivateCertificateCryptoProvider" } } }, "PrivateCertificateCAMaxTTL": { "description": "The maximum time-to-live (TTL) for certificates that are created by this CA.\n\nThe value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response,\nthis value is returned in seconds (integer).\n\nMinimum value is one hour (`1h`). Maximum value is 100 years (`876000h`).", "type": "string", "x-cli-option-name": "private-cert-max-ttl", "x-cli-description": "The maximum time-to-live (TTL) for certificates that are created by this CA.", "pattern": "^[0-9]+[s,m,h,d]{0,1}$", "minLength": 2, "maxLength": 10, "example": "8760h" }, "PrivateCertificateCAMaxTTLSeconds": { "description": "The maximum time-to-live (TTL) for certificates that are created by this CA in seconds.", "type": "integer", "format": "int64", "readOnly": true, "minimum": 0, "maximum": 3155760000, "example": 157788000 }, "PrivateCertificateTemplateTTL": { "description": "The requested time-to-live (TTL) for certificates that are created by this CA. This field's value can't be longer than the `max_ttl` limit.\n\nThe value can be supplied as a string representation of a duration in hours, for example '8760h'. In the API response,\nthis value is returned in seconds (integer).", "type": "string", "pattern": "^[0-9]+[s,m,h,d]{0,1}$", "x-cli-option-name": "private-cert-ttl", "x-cli-description": "The requested time-to-live (TTL) for certificates that are created by this CA.", "minLength": 2, "maxLength": 10, "example": "8760h" }, "PrivateCertificateTemplateTTLSeconds": { "description": "he requested TTL, after which the certificate expires.", "type": "integer", "format": "int64", "readOnly": true, "example": 31536000, "minimum": 3600, "maximum": 3155760000 }, "PrivateCertificateCRLExpiry": { "description": "The time until the certificate revocation list (CRL) expires.\n\nThe value can be supplied as a string representation of a duration in hours, such as `48h`. The default is 72 hours.\nIn the API response, this value is returned in seconds (integer).\n\n**Note:** The CRL is rotated automatically before it expires.", "type": "string", "x-cli-option-name": "private-cert-crl-expiry", "x-cli-description": "The time until the certificate revocation list (CRL) expires.", "pattern": "^[0-9]+[s,m,h,d]{0,1}$", "minLength": 2, "maxLength": 10, "example": "72h" }, "PrivateCertificateCRLExpirySeconds": { "description": "The time until the certificate revocation list (CRL) expires, in seconds.", "type": "integer", "format": "int64", "readOnly": true, "example": 259200, "minimum": 0, "maximum": 3155760000 }, "PrivateCertificateCRLDisabled": { "description": "This field disables or enables certificate revocation list (CRL) building.\n\nIf CRL building is disabled, a signed but zero-length CRL is returned when you're downloading the CRL. If CRL building is enabled, it rebuilds the CRL.", "type": "boolean", "x-cli-option-name": "private-cert-crl-disabled", "x-cli-description": "This field disables or enables certificate revocation list (CRL) building." }, "PrivateCertificateCRLDistributionPointsEncoded": { "description": "This field determines whether to encode the certificate revocation list (CRL) distribution points in the\ncertificates that are issued by this certificate authority.", "type": "boolean", "x-cli-option-name": "private-cert-crl-distribution-points-encoded" }, "PrivateCertificateIssuingCertificatesUrlsEncoded": { "description": "This field determines whether to encode the URL of the issuing certificate in the certificates that are\nissued by this certificate authority.", "type": "boolean", "x-cli-option-name": "private-cert-issuing-certificate-urls-encoded" }, "PrivateCertificateCAStatus": { "description": "The status of the certificate authority. The status of a root certificate authority is either `configured`\nor `expired`. For intermediate certificate authorities, possible statuses include `signing_required`,\n`signed_certificate_required`, `certificate_template_required`, `configured`, `expired` or `revoked`.", "readOnly": true, "type": "string", "enum": [ "signing_required", "signed_certificate_required", "certificate_template_required", "configured", "expired", "revoked" ] }, "PrivateCertificatePrivateKeyType": { "description": "The type of private key to generate.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "private-cert-private-key-type", "enum": [ "rsa", "ec" ] }, "PrivateCertificatePrivateKeyBits": { "description": "The number of bits to use to generate the private key.\n\nAllowable values for RSA keys are: `2048` and `4096`. Allowable values for EC keys are: `224`, `256`, `384`, and `521`.\nThe default for RSA keys is `2048`. The default for EC keys is `256`.", "type": "integer", "format": "int32", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "private-cert-private-key-bits", "x-cli-description": "The number of bits to use to generate the private key.", "minimum": 224, "maximum": 4096, "example": 4096 }, "PrivateCertificateMaxPathLength": { "description": "The maximum path length to encode in the generated certificate. `-1` means no limit.\n\nIf the signing certificate has a maximum path length set, the path length is set to one less than that of the\nsigning certificate. A limit of `0` means a literal path length of zero.", "type": "integer", "format": "int32", "minimum": -1, "maximum": 10, "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "private-cert-max-path-length", "x-cli-description": "The maximum path length to encode in the generated certificate. `-1` means no limit." }, "PrivateCertificatePermittedDnsDomains": { "description": "The allowed DNS domains or subdomains for the certificates that are to be signed and issued by this CA certificate.", "type": "array", "x-cli-option-name": "private-cert-permitted-dns-domains", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 128 }, "x-terraform-force-new": true, "x-terraform-computed": true }, "PrivateCertificateSubjectOrganizationalUnit": { "description": "The Organizational Unit (OU) values to define in the subject field of the resulting certificate.", "type": "array", "x-cli-option-name": "private-cert-subject-organizational-unit", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 128 }, "x-terraform-force-new": true, "x-terraform-computed": true }, "PrivateCertificateSubjectOrganization": { "description": "The Organization (O) values to define in the subject field of the resulting certificate.", "type": "array", "x-cli-option-name": "private-cert-subject-organization", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 128 }, "x-terraform-force-new": true, "x-terraform-computed": true }, "PrivateCertificateSubjectCountry": { "description": "The Country (C) values to define in the subject field of the resulting certificate.", "type": "array", "x-cli-option-name": "private-cert-subject-country", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 128 }, "x-terraform-force-new": true, "x-terraform-computed": true }, "PrivateCertificateSubjectLocality": { "description": "The Locality (L) values to define in the subject field of the resulting certificate.", "type": "array", "x-cli-option-name": "private-cert-subject-locality", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 64 }, "x-terraform-force-new": true, "x-terraform-computed": true }, "PrivateCertificateSubjectProvince": { "description": "The Province (ST) values to define in the subject field of the resulting certificate.", "type": "array", "x-cli-option-name": "private-cert-subject-province", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 64 }, "x-terraform-force-new": true, "x-terraform-computed": true }, "PrivateCertificateSubjectStreetAddress": { "description": "The street address values to define in the subject field of the resulting certificate.", "type": "array", "x-cli-option-name": "private-cert-subject-street-address", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 256 }, "x-terraform-force-new": true, "x-terraform-computed": true }, "PrivateCertificateSubjectPostalCode": { "description": "The postal code values to define in the subject field of the resulting certificate.", "type": "array", "x-cli-option-name": "private-cert-subject-postal-code", "minItems": 0, "maxItems": 10, "items": { "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 64 }, "x-terraform-force-new": true, "x-terraform-computed": true }, "PrivateCertificateRequestedSerialNumber": { "description": "The requested value for the [`serialNumber`](https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute that is in the certificate's distinguished name (DN). \n\n**Note:** This field is not related to the `serial_number` field that is returned in the API response. The `serial_number` field represents the certificate's randomly assigned serial number.", "minLength": 32, "maxLength": 64, "type": "string", "x-cli-option-name": "private-cert-serial-number", "x-cli-description": " The requested value for the `serialNumber` (https://datatracker.ietf.org/doc/html/rfc4519#section-2.31) attribute that is in the certificate's distinguished name (DN). ", "pattern": "[^a-fA-F0-9]", "example": "d9:be:fe:35:ba:09:42:b5:35:ba:09:42:b5", "x-terraform-force-new": true, "x-terraform-computed": true }, "PrivateCertificateCryptoProviderType": { "type": "string", "description": "The type of cryptographic provider.", "enum": [ "hyper_protect_crypto_services" ] }, "PrivateCertificateCryptoProviderInstanceCrn": { "type": "string", "description": "The HPCS instance CRN.", "pattern": "^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@/]|%[0-9A-Z]{2})*){8}$", "minLength": 9, "maxLength": 512, "example": "crn:v1:bluemix:public:hs-crypto:us-south:a/791f3fb10486421e97aa8512f18b7e65:b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5::" }, "PrivateCertificateCryptoKeyAllowGenerateKey": { "type": "boolean", "default": false, "description": "The indication of whether a new key is generated by the crypto provider if the given key name cannot be found." }, "PrivateCertificateCryptoProviderPrivateKeystoreId": { "type": "string", "description": "The HPCS private key store space id.", "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", "minLength": 36, "maxLength": 36, "example": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5" }, "PrivateCertificateCryptoProviderPinIamCredentialsSecretId": { "type": "string", "description": "The secret Id of iam credentials with api key to access HPCS instance.", "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", "minLength": 36, "maxLength": 36, "example": "6ebb80d3-26d1-4e24-81d6-afb0d8e22f54" }, "PrivateCertificateCryptoKeyLabel": { "type": "string", "description": "The label of the key to use. If the key does not exist and generation is enabled, this field is the label that is given to the generated key. \nIf the key exists, and generation is disabled, then this label is used to look up the key. This value or the crypto key ID must be specified.", "pattern": "^[A-Za-z0-9._ /-]+$", "minLength": 1, "maxLength": 255, "example": "my_key" }, "PrivateCertificateCryptoKeyId": { "type": "string", "description": "The ID of a PKCS#11 key to use. If the key does not exist and generation is enabled, this ID is given to the generated key. \nIf the key exists, and generation is disabled, then this ID is used to look up the key. This value or the crypto key label must be specified.", "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", "minLength": 36, "maxLength": 36, "example": "ad629506-3aca-4191-b8fc-8b295ec7a19c" }, "PrivateCertificateTemplateSerialNumber": { "type": "string", "description": "This field is deprecated. You can ignore its value.", "x-cli-option-name": "private-cert-requested-serial-number", "minLength": 32, "maxLength": 64, "pattern": "[^a-fA-F0-9]", "example": "d9:be:fe:35:ba:09:42:b5:35:ba:09:42:b5", "x-terraform-force-new": true, "x-terraform-computed": true }, "PrivateCertificateSigningMethod": { "description": "The signing method to use with this certificate authority to generate private certificates.\n\nYou can choose between internal or externally signed options. For more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-intermediate-certificate-authorities).", "type": "string", "x-terraform-force-new": true, "x-cli-option-name": "private-cert-signing-method", "x-cli-description": "The signing method to use with this certificate authority to generate private certificates.", "enum": [ "internal", "external" ] }, "PrivateCertificateTemplateAllowLocalhost": { "type": "boolean", "x-cli-option-name": "private-cert-allow-localhost", "description": "This field indicates whether to allow `localhost` to be included as one of the requested common names." }, "PrivateCertificateTemplateAllowedDomains": { "description": "The domains to define for the certificate template. This property is used along with the `allow_bare_domains` and `allow_subdomains` options.", "type": "array", "x-cli-option-name": "private-cert-allowed-domains", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 128 } }, "PrivateCertificateTemplateAllowedDomainsTemplate": { "type": "boolean", "x-cli-option-name": "private-cert-allowed-domains-template", "description": "This field indicates whether to allow the domains that are supplied in the `allowed_domains` field to contain access control list (ACL) templates." }, "PrivateCertificateTemplateAllowBareDomains": { "type": "boolean", "description": "This field indicates whether to allow clients to request private certificates that match the value of the actual\ndomains on the final certificate.\n\nFor example, if you specify `example.com` in the `allowed_domains` field, you grant clients the ability to\nrequest a certificate that contains the name `example.com` as one of the DNS values on the final certificate.\n\n**Important:** In some scenarios, allowing bare domains can be considered a security risk.", "x-cli-option-name": "private-cert-allow-bare-domains", "x-cli-description": "This field indicates whether to allow clients to request private certificates that match the value of the actual domains on the final certificate." }, "PrivateCertificateTemplateAllowSubdomains": { "type": "boolean", "description": "This field indicates whether to allow clients to request private certificates with common names (CN) that are subdomains\nof the CNs that are allowed by the other certificate template options. This includes wildcard subdomains.\n\nFor example, if `allowed_domains` has a value of `example.com` and `allow_subdomains`is set to `true`, then\nthe following subdomains are allowed: `foo.example.com`, `bar.example.com`, `*.example.com`.\n\n**Note:** This field is redundant if you use the `allow_any_name` option.", "x-cli-option-name": "private-cert-allow-subdomains", "x-cli-description": "This field indicates whether to allow clients to request private certificates with common names (CN) that are subdomains of the CNs that are allowed by the other certificate template options" }, "PrivateCertificateTemplateAllowGlobDomains": { "type": "boolean", "description": "This field indicates whether to allow glob patterns, for example, `ftp*.example.com`, in the names that are specified\nin the `allowed_domains` field.\n\nIf set to `true`, clients are allowed to request private certificates with names that match the glob patterns.", "x-cli-option-name": "private-cert-allow-glob-domains", "x-cli-description": "This field indicates whether to allow glob patterns in the names that are specified in the `allowed_domains` field." }, "PrivateCertificateTemplateAllowWildCard": { "type": "boolean", "description": "This field indicates whether the issuance of certificates with RFC 6125 wildcards in the CN field.\n\nWhen set to false, this field prevents wildcards from being issued\neven if they can be allowed by an option `allow_glob_domains`.", "x-cli-option-name": "private-cert-allow-wildcard", "x-cli-description": "This field indicates whether the issuance of certificates with RFC 6125 wildcards in the CN field." }, "PrivateCertificateTemplateAllowAnyName": { "type": "boolean", "description": "This field indicates whether to allow clients to request a private certificate that matches any common name.", "x-cli-option-name": "private-cert-allow-any-name" }, "PrivateCertificateTemplateEnforceHostnames": { "type": "boolean", "description": "This field indicates whether to enforce only valid hostnames for common names, DNS Subject Alternative Names, and the\nhost section of email addresses.", "x-cli-option-name": "private-cert-enforce-hostname" }, "PrivateCertificateTemplateAllowIpSans": { "type": "boolean", "description": "This field indicates whether to allow clients to request a private certificate with IP Subject Alternative Names.", "x-cli-option-name": "private-cert-allow-ip-sans" }, "PrivateCertificateTemplateAllowedUriSans": { "description": "The URI Subject Alternative Names to allow for private certificates.\n\nValues can contain glob patterns, for example `spiffe://hostname/*`.", "type": "array", "x-cli-option-name": "private-cert-allowed-uri-sans", "x-cli-description": "The URI Subject Alternative Names to allow for private certificates.", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 2048 } }, "PrivateCertificateTemplateAllowedOtherSans": { "description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names (SANs) to allow for private\ncertificates.\n\nThe format for each element in the list\nis the same as OpenSSL: `::` where the current valid type is `UTF8`. To allow any value\nfor an OID, use `*` as its value. Alternatively, specify a single `*` to allow any `other_sans` input.", "type": "array", "x-cli-option-name": "private-cert-allowed-other-sans", "x-cli-description": "The custom Object Identifier (OID) or UTF8-string Subject Alternative Names (SANs) to allow for private certificates.", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 256 }, "example": [ "2.5.4.5;UTF8:*" ] }, "PrivateCertificateTemplateServerFlag": { "type": "boolean", "description": "This field indicates whether private certificates are flagged for server use.", "x-cli-option-name": "private-cert-server-flag" }, "PrivateCertificateTemplateClientFlag": { "type": "boolean", "description": "This field indicates whether private certificates are flagged for client use.", "x-cli-option-name": "private-cert-client-flag" }, "PrivateCertificateTemplateCodeSigningFlag": { "type": "boolean", "description": "This field indicates whether private certificates are flagged for code signing use.", "x-cli-option-name": "private-cert-code-signing-flag" }, "PrivateCertificateTemplateEmailProtectionFlag": { "type": "boolean", "description": "This field indicates whether private certificates are flagged for email protection use.", "x-cli-option-name": "private-cert-email-protection-flag" }, "PrivateCertificateConfigurationIntermediateCAName": { "type": "string", "description": "The name of the intermediate certificate authority.", "pattern": "^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$", "x-cli-option-name": "private-cert-CA-name", "minLength": 2, "maxLength": 128 }, "PrivateCertificateTemplateAllowedSecretGroups": { "type": "string", "description": "This field scopes the creation of private certificates to only the secret groups that you specify.\n\nThis field can be supplied as a comma-delimited list of secret group IDs.", "pattern": "(.*?)", "x-cli-option-name": "private-cert-allowed-secret-groups", "x-cli-description": "This field scopes the creation of private certificates to only the secret groups that you specify.", "minLength": 2, "maxLength": 1024 }, "PrivateCertificateTemplateKeyUsage": { "description": "The allowed key usage constraint to define for private certificates.\n\nYou can find valid values in the [Go x509 package documentation](https://pkg.go.dev/crypto/x509#KeyUsage).\nOmit the `KeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints,\nset this field to an empty list.", "type": "array", "x-cli-option-name": "private-cert-key-usage", "x-cli-description": "The allowed key usage constraint to define for private certificates.", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": "^[a-zA-Z]+$", "minLength": 1, "maxLength": 128 }, "example": [ "DigitalSignature", "KeyAgreement", "KeyEncipherment" ] }, "PrivateCertificateTemplateExtKeyUsage": { "description": "The allowed extended key usage constraint on private certificates.\n\nYou can find valid values in the [Go x509 package documentation](https://golang.org/pkg/crypto/x509/#ExtKeyUsage).\nOmit the `ExtKeyUsage` part of the value. Values are not case-sensitive. To specify no key usage constraints,\nset this field to an empty list.", "type": "array", "x-cli-option-name": "private-cert-ext-key-usage", "x-cli-description": "The allowed extended key usage constraint on private certificates.", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": "^[a-zA-Z]+$", "minLength": 1, "maxLength": 128 } }, "PrivateCertificateTemplateExtKeyUsageOids": { "description": "A list of extended key usage Object Identifiers (OIDs).", "type": "array", "x-cli-option-name": "private-cert-ext-key-usage-oids", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": "(.*?)", "minLength": 1, "maxLength": 256 } }, "PrivateCertificateTemplateUseCSRCommonName": { "type": "boolean", "description": "When used with the `private_cert_configuration_action_sign_csr` action, this field determines whether to use the common name (CN) from a\ncertificate signing request (CSR) instead of the CN that is included in the data of the certificate.\n\nDoes not include any requested Subject Alternative Names (SANs) in the CSR. To use the alternative names,\ninclude the `use_csr_sans` property.", "x-cli-option-name": "private-cert-use-csr-common-name", "x-cli-description": "this field determines whether to use the common name (CN) from a certificate signing request (CSR)" }, "PrivateCertificateTemplateUseCSRSans": { "type": "boolean", "description": "When used with the `private_cert_configuration_action_sign_csr` action, this field determines whether to use the Subject Alternative Names\n(SANs) from a certificate signing request (CSR) instead of the SANs that are included in the data of\nthe certificate.\n\nThis field does not include the common name in the CSR. To use the common name, include the `use_csr_common_name`\nproperty.", "x-cli-option-name": "private-cert-use-cse-sans", "x-cli-description": "this field determines whether to use the Subject Alternative Names (SANs) from a certificate signing request (CSR)" }, "PrivateCertificateTemplateRequireCN": { "type": "boolean", "description": "This field indicates whether to require a common name to create a private certificate.\n\nBy default, a common name is required to generate a certificate. To make the `common_name` field optional,\nset the `require_cn` option to `false`.", "x-cli-option-name": "private-cert-require-cn", "x-cli-description": "This field indicates whether to require a common name to create a private certificate." }, "PrivateCertificateTemplatePolicyIdentifiers": { "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 256 }, "description": "A list of policy Object Identifiers (OIDs).", "x-cli-option-name": "private-cert-policy-identifiers" }, "PrivateCertificateTemplateBasicConstraintsValidForNonCA": { "type": "boolean", "description": "This field indicates whether to mark the Basic Constraints extension of an issued private certificate as valid for non-CA\ncertificates.", "x-cli-option-name": "private-cert-basic-constraints-valid-for-non-ca" }, "PrivateCertificateTemplateNotBeforeDuration": { "type": "string", "description": "The duration in seconds by which to backdate the `not_before` property of an issued private certificate.\n\nThe value can be supplied as a string representation of a duration, such as `30s`. In the API response, this value\nis returned in seconds (integer).", "x-cli-option-name": "private-cert-not-before-duration", "x-cli-description": "The duration in seconds by which to backdate the `not_before` property of an issued private certificate.", "pattern": "^[0-9]+[s,m,h,d]{0,1}$", "minLength": 2, "maxLength": 10, "example": "30s" }, "PrivateCertificateTemplateNotBeforeDurationSeconds": { "type": "integer", "format": "int32", "readOnly": true, "description": "The duration in seconds by which to backdate the `not_before` property of an issued private certificate.", "example": 30, "minimum": 0, "maximum": 86400 }, "PrivateCertificateUseCsrValues": { "type": "boolean", "description": "This field indicates whether to use values from a certificate signing request (CSR) to complete a `private_cert_configuration_action_sign_csr` action. If it is\nset to `true`, then:\n\n1) Subject information, including names and alternate names, are preserved from the CSR rather than by using\nthe values that are provided in the other parameters to this operation.\n\n2) Any key usage, for example, non-repudiation, that is requested in the CSR are added to the basic set\nof key usages used for CA certificates that are signed by the intermediate authority.\n\n3) Extensions that are requested in the CSR are copied into the issued private certificate." }, "ArbitrarySecretPayload": { "title": "ArbitrarySecretPayload", "x-child-schema-name": "ArbitrarySecretPayload", "description": "Your arbitrary secret's payload.", "type": "object", "x-terraform-sensitive": true, "properties": { "payload": { "$ref": "#/components/schemas/ArbitrarySecretDataPayload" } } }, "ArbitrarySecretDataPayload": { "description": "The secret data that is assigned to an `arbitrary` secret.", "type": "string", "x-terraform-force-new": true, "x-cli-option-name": "arbitrary-payload", "minLength": 0, "maxLength": 1000000, "pattern": "(.*?)", "example": "secret-credentials" }, "PublicCertificateConfigurationDNSCloudInternetServicesPrototype": { "title": "PublicCertificateConfigurationDNSCloudInternetServicesPrototype", "x-child-schema-name": "PublicCertificateConfigurationDNSCloudInternetServicesPrototype", "description": "Specify the properties for Cloud Internet Services DNS configuration.", "type": "object", "additionalProperties": false, "required": [ "config_type", "name", "cloud_internet_services_crn" ], "properties": { "config_type": { "$ref": "#/components/schemas/ConfigurationType" }, "name": { "$ref": "#/components/schemas/ConfigurationName" }, "cloud_internet_services_apikey": { "$ref": "#/components/schemas/DNSCloudInternetServicesApikey" }, "cloud_internet_services_crn": { "$ref": "#/components/schemas/DNSCloudInternetServicesCRN" } } }, "PublicCertificateConfigurationDNSCloudInternetServicesData": { "title": "PublicCertificateConfigurationDNSCloudInternetServicesData", "x-child-schema-name": "PublicCertificateConfigurationDNSCloudInternetServicesData", "description": "The configuration of Cloud Internet Services' DNS data.", "type": "object", "required": [ "cloud_internet_services_crn" ], "properties": { "cloud_internet_services_apikey": { "$ref": "#/components/schemas/DNSCloudInternetServicesApikey" }, "cloud_internet_services_crn": { "$ref": "#/components/schemas/DNSCloudInternetServicesCRN" } } }, "DNSCloudInternetServicesCRN": { "title": "DNSCloudInternetServicesCRN", "x-cli-option-name": "public-cert-cloud-internet-services-crn", "description": "A CRN that uniquely identifies an IBM Cloud resource.", "type": "string", "format": "crn", "pattern": "^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@/]|%[0-9A-Z]{2})*){8}$", "minLength": 9, "maxLength": 512 }, "DNSCloudInternetServicesApikey": { "title": "DNSCloudInternetServicesApikey", "description": "An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.\n\nTo grant Secrets Manager the ability to view the Cloud Internet Services instance and all of its domains, the\nAPI key must be assigned the Reader service role on Internet Services (`internet-svcs`).\nIn order to add DNS records you need to assign the Manager role.\n\nIf you want to manage specific domains, you can assign the Manager role for this specific domain. \nFor production environments, it is recommended that you assign the Reader access role, and then use the\n[IAM Policy Management API](https://cloud.ibm.com/apidocs/iam-policy-management#create-policy)\nto control specific domains. \n\nIf an IBM Cloud API key value is empty Secrets Manager tries to access your Cloud Internet Services instance \nwith service-to-service authorization.\n\nFor more information, see the [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates#authorize-cis).", "x-terraform-sensitive": true, "x-cli-option-name": "public-cert-cloud-internet-services-apikey", "x-cli-description": "An IBM Cloud API key that can list domains in your Cloud Internet Services instance and add DNS records.", "type": "string", "pattern": "(.*?)", "minLength": 0, "maxLength": 128 }, "PublicCertificateConfigurationDNSClassicInfrastructurePrototype": { "title": "PublicCertificateConfigurationDNSClassicInfrastructurePrototype", "x-child-schema-name": "PublicCertificateConfigurationDNSClassicInfrastructurePrototype", "type": "object", "additionalProperties": false, "required": [ "config_type", "name", "classic_infrastructure_username", "classic_infrastructure_password" ], "properties": { "config_type": { "$ref": "#/components/schemas/ConfigurationType" }, "name": { "$ref": "#/components/schemas/ConfigurationName" }, "classic_infrastructure_username": { "$ref": "#/components/schemas/DNSClassicInfrastructureUsername" }, "classic_infrastructure_password": { "$ref": "#/components/schemas/DNSClassicInfrastructurePassword" } } }, "IAMCredentialsConfigurationPrototype": { "title": "IAMCredentialsConfigurationPrototype", "x-child-schema-name": "IAMCredentialsConfigurationPrototype", "type": "object", "additionalProperties": false, "required": [ "name", "config_type", "api_key" ], "properties": { "name": { "$ref": "#/components/schemas/ConfigurationName" }, "config_type": { "$ref": "#/components/schemas/ConfigurationType" }, "api_key": { "$ref": "#/components/schemas/IAMCredentialsConfigurationApiKey" }, "disabled": { "$ref": "#/components/schemas/IAMCredentialsConfigurationDisabled" } } }, "IAMCredentialsConfigurationApiKey": { "title": "IAMCredentialsConfigurationApiKey", "x-cli-option-name": "iam-credentials-apikey", "description": "The API key that is used to set the iam_credentials engine.", "x-terraform-sensitive": true, "type": "string", "pattern": "^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$", "minLength": 5, "maxLength": 60 }, "IAMCredentialsConfigurationDisabled": { "title": "Disabled", "description": "This parameter indicates whether the API key configuration is disabled.\n\nIf it is set to `true`, the IAM credentials engine doesn't use the configured API key for credentials management.", "type": "boolean", "default": false, "x-cli-option-name": "iam-credentials-apikey-disabled", "x-cli-description": "This parameter indicates whether the API key configuration is disabled." }, "IAMCredentialsConfigurationDisabledForPatch": { "title": "Disabled", "description": "This parameter indicates whether the API key configuration is disabled. \n\nIf it is set to `disabled`, the IAM credentials engine doesn't use the configured API key for credentials management.", "type": "boolean", "x-cli-option-name": "iam-credentials-apikey-disabled", "x-cli-description": "This parameter indicates whether the API key configuration is disabled." }, "IAMCredentialsConfigurationDisabledRO": { "title": "Disabled", "description": "This parameter indicates whether the API key configuration is disabled.", "type": "boolean" }, "CustomCredentialsConfigurationApiKey": { "title": "CustomCredentialsConfigurationApiKey", "x-cli-option-name": "custom-credentials-apikey-ref", "description": "The IAM credentials secret ID that is used for setting up a custom credentials engine configuration.", "x-terraform-sensitive": true, "type": "string", "format": "identifier", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36, "example": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5" }, "CodeEngineKeyRef": { "title": "CodeEngineKeyRef", "x-cli-option-name": "code-engine-key-ref", "description": "The IAM API key used by the credentials provider to access this Secrets Manager instance.", "x-terraform-sensitive": true, "type": "string", "pattern": "^sm-access-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 46, "maxLength": 46, "example": "sm-access-b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5" }, "CodeEngineJobName": { "title": "CodeEngineJobName", "description": "The Code Engine Job name used by this custom credentials configuration.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "code-engine-job-name", "x-cli-description": "The Code Engine job name used by this custom credentials configuration.", "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, "maxLength": 63, "example": "sm-custom-cred-job" }, "CodeEngineProjectId": { "title": "CodeEngineProjectId", "description": "The Project ID of your Code Engine project used by this custom credentials configuration.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "code-engine-project-id", "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "x-cli-description": "The Project ID of your Code Engine project used by this custom credentials configuration.", "minLength": 36, "maxLength": 36, "example": "15314cc3-85b4-4338-903f-c28cdee6d005" }, "CodeEngineRegion": { "title": "CodeEngineRegion", "description": "The region of the Code Engine project. For example us-south.", "type": "string", "x-terraform-force-new": true, "x-terraform-computed": true, "x-cli-option-name": "code-engine-region", "x-cli-description": "The region of the Code Engine project. For example us-south.", "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, "maxLength": 63, "example": "us-south" }, "CustomCredentialsConfigurationCodeEngine": { "title": "CustomCredentialsConfigurationCodeEngine", "x-cli-option-name": "custom-credentials-code-engine", "description": "The parameters required to configure Code Engine.", "x-terraform-sensitive": true, "type": "object", "additionalProperties": false, "required": [ "job_name", "project_id", "region" ], "properties": { "job_name": { "$ref": "#/components/schemas/CodeEngineJobName" }, "project_id": { "$ref": "#/components/schemas/CodeEngineProjectId" }, "region": { "$ref": "#/components/schemas/CodeEngineRegion" } } }, "CustomCredentialsConfigurationSchema": { "title": "CustomCredentialsConfigurationSchema", "x-cli-option-name": "custom-credentials-schema", "description": "The schema that defines by the Code Engine job to be used as input and output formats for this custom credentials configuration.", "x-terraform-sensitive": true, "type": "object", "additionalProperties": false, "required": [ "parameters", "credentials" ], "properties": { "parameters": { "type": "array", "minItems": 0, "maxItems": 256, "description": "custom credentials configuration schema parameter.", "items": { "$ref": "#/components/schemas/CustomCredentialsConfigurationSchemaParameter" } }, "credentials": { "type": "array", "minItems": 1, "maxItems": 256, "description": "custom credentials configuration schema credentials format.", "items": { "$ref": "#/components/schemas/CustomCredentialsConfigurationSchemaCredentials" } } } }, "CustomCredentialsConfigurationSchemaCredentials": { "title": "CustomCredentialsConfigurationSchemaCredentials", "x-cli-option-name": "custom-credentials-configuration-parameter", "description": "The format of the credentials of a custom credentials schema, for example {\"name\":\"access_token\", \"format\":\"type:string, required:true\"}", "x-terraform-sensitive": true, "type": "object", "additionalProperties": false, "required": [ "name", "format" ], "properties": { "name": { "$ref": "#/components/schemas/CustomCredentialsConfigurationSchemaParameterName" }, "format": { "$ref": "#/components/schemas/CustomCredentialsConfigurationSchemaParameterFormat" } } }, "CustomCredentialsConfigurationSchemaParameter": { "title": "CustomCredentialsConfigurationSchemaParameter", "x-cli-option-name": "custom-credentials-schema-parameter", "description": "A parameter of a custom credentials schema, for example {\"name\":\"user_name\", \"format\":\"type:string, required:true\"}", "x-terraform-sensitive": true, "type": "object", "additionalProperties": false, "required": [ "name", "format" ], "properties": { "name": { "$ref": "#/components/schemas/CustomCredentialsConfigurationSchemaParameterName" }, "format": { "$ref": "#/components/schemas/CustomCredentialsConfigurationSchemaParameterFormat" }, "env_variable_name": { "$ref": "#/components/schemas/CustomCredentialsConfigurationSchemaParameterEnvVariableName" } } }, "CustomCredentialsConfigurationSchemaParameterName": { "title": "CustomCredentialsConfigurationSchemaParameterName", "x-cli-option-name": "custom-credentials-schema-parameter-name", "description": "The name of a parameter.", "x-terraform-sensitive": true, "type": "string", "pattern": "^[-._a-zA-Z0-9]+$", "minLength": 1, "maxLength": 253, "example": "user_name" }, "CustomCredentialsConfigurationSchemaParameterEnvVariableName": { "title": "CustomCredentialsConfigurationSchemaParameterEnvVariableName", "x-cli-option-name": "custom-credentials-schema-parameter-env-variable-name", "description": "The name of the environment variable of a custom credentials configuration schema parameter.", "x-terraform-sensitive": true, "type": "string", "pattern": "^[-._a-zA-Z0-9]+$", "minLength": 1, "maxLength": 253, "example": "SM_USER_NAME_VALUE" }, "CustomCredentialsConfigurationSchemaParameterFormat": { "title": "CustomCredentialsConfigurationSchemaParameterFormat", "x-cli-option-name": "custom-credentials-schema-parameter-format", "description": "The format of the custom credentials parameter, for example 'required:true, type:string', 'type:int, required:false', 'type:enum[val1|val2|val3], required:true', 'required:true, type:boolean'", "x-terraform-sensitive": true, "type": "string", "pattern": "^(.*?)$", "minLength": 1, "maxLength": 512, "example": "required:true, type:string" }, "CustomCredentialsConfigurationPrototype": { "title": "CustomCredentialsConfigurationPrototype", "x-child-schema-name": "CustomCredentialsConfigurationPrototype", "type": "object", "additionalProperties": false, "required": [ "name", "config_type", "code_engine" ], "properties": { "name": { "$ref": "#/components/schemas/ConfigurationName" }, "config_type": { "$ref": "#/components/schemas/ConfigurationType" }, "api_key_ref": { "$ref": "#/components/schemas/CustomCredentialsConfigurationApiKey" }, "code_engine": { "$ref": "#/components/schemas/CustomCredentialsConfigurationCodeEngine" }, "task_timeout": { "$ref": "#/components/schemas/TaskTimeout" } } }, "PublicCertificateConfigurationDNSClassicInfrastructureData": { "title": "PublicCertificateConfigurationDNSClassicInfrastructureData", "x-child-schema-name": "PublicCertificateConfigurationDNSClassicInfrastructureData", "description": "Properties that describe an IBM Cloud classic infrastructure (SoftLayer) configuration.", "type": "object", "required": [ "classic_infrastructure_username", "classic_infrastructure_password" ], "properties": { "classic_infrastructure_username": { "$ref": "#/components/schemas/DNSClassicInfrastructureUsername" }, "classic_infrastructure_password": { "$ref": "#/components/schemas/DNSClassicInfrastructurePassword" } } }, "DNSClassicInfrastructureUsername": { "description": "The username that is associated with your classic infrastructure account.\n\nIn most cases, your classic infrastructure username is your `_`. For more\ninformation, see the [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).", "type": "string", "x-cli-option-name": "public-cert-classic-infrastructure-username", "x-cli-description": "The username that is associated with your classic infrastructure account.", "pattern": "(.*?)", "minLength": 2, "maxLength": 128 }, "DNSClassicInfrastructurePassword": { "description": "Your classic infrastructure API key.\n\nFor information about viewing and accessing your classic infrastructure API key, see the [docs](https://cloud.ibm.com/docs/account?topic=account-classic_keys).", "x-terraform-sensitive": true, "x-cli-option-name": "public-cert-classic-infrastructure-password", "x-cli-description": "Your classic infrastructure API key.", "type": "string", "pattern": "(.*?)", "minLength": 2, "maxLength": 128 }, "Configuration": { "title": "Configuration", "description": "Your configuration.", "oneOf": [ { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncrypt" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSCloudInternetServices" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSClassicInfrastructure" }, { "$ref": "#/components/schemas/IAMCredentialsConfiguration" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationRootCA" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationIntermediateCA" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationTemplate" }, { "$ref": "#/components/schemas/CustomCredentialsConfiguration" } ], "discriminator": { "propertyName": "config_type", "mapping": { "public_cert_configuration_dns_cloud_internet_services": "#/components/schemas/PublicCertificateConfigurationDNSCloudInternetServices", "public_cert_configuration_dns_classic_infrastructure": "#/components/schemas/PublicCertificateConfigurationDNSClassicInfrastructure", "public_cert_configuration_ca_lets_encrypt": "#/components/schemas/PublicCertificateConfigurationCALetsEncrypt", "iam_credentials_configuration": "#/components/schemas/IAMCredentialsConfiguration", "private_cert_configuration_root_ca": "#/components/schemas/PrivateCertificateConfigurationRootCA", "private_cert_configuration_intermediate_ca": "#/components/schemas/PrivateCertificateConfigurationIntermediateCA", "private_cert_configuration_template": "#/components/schemas/PrivateCertificateConfigurationTemplate", "custom_credentials_configuration": "#/components/schemas/CustomCredentialsConfiguration" } } }, "ConfigurationPatch": { "title": "ConfigurationPatch", "description": "Your configuration update data.", "anyOf": [ { "$ref": "#/components/schemas/IAMCredentialsConfigurationPatch" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationRootCAPatch" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationIntermediateCAPatch" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationTemplatePatch" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptPatch" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSCloudInternetServicesPatch" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSClassicInfrastructurePatch" }, { "$ref": "#/components/schemas/CustomCredentialsConfigurationPatch" } ] }, "CustomCredentialsConfigurationPatch": { "title": "CustomCredentialsConfigurationPatch", "x-child-schema-name": "CustomCredentialsConfigurationPatch", "description": "The configuration update of the custom credentials engine.", "type": "object", "additionalProperties": false, "properties": { "task_timeout": { "$ref": "#/components/schemas/TaskTimeout" } } }, "IAMCredentialsConfigurationPatch": { "title": "IAMCredentialsConfigurationPatch", "x-child-schema-name": "IAMCredentialsConfigurationPatch", "description": "The configuration update of the IAM Credentials engine.", "type": "object", "additionalProperties": false, "properties": { "api_key": { "$ref": "#/components/schemas/ApiKeyConfiguration" }, "disabled": { "$ref": "#/components/schemas/IAMCredentialsConfigurationDisabledForPatch" } } }, "PublicCertificateConfigurationCALetsEncryptPatch": { "title": "PublicCertificateConfigurationCALetsEncryptPatch", "x-child-schema-name": "PublicCertificateConfigurationCALetsEncryptPatch", "description": "The configuration update of the Let's Encrypt Certificate Authority.", "type": "object", "additionalProperties": false, "required": [ "lets_encrypt_environment" ], "properties": { "lets_encrypt_environment": { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptEnvironment" }, "lets_encrypt_private_key": { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptPrivateKey" }, "lets_encrypt_preferred_chain": { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptPreferredChain" } } }, "PublicCertificateConfigurationDNSCloudInternetServicesPatch": { "title": "PublicCertificateConfigurationDNSCloudInternetServicesPatch", "x-child-schema-name": "PublicCertificateConfigurationDNSCloudInternetServicesPatch", "description": "The configuration update of the Cloud Internet Services DNS.", "type": "object", "additionalProperties": false, "required": [ "cloud_internet_services_apikey" ], "properties": { "cloud_internet_services_apikey": { "$ref": "#/components/schemas/DNSCloudInternetServicesApikey" }, "cloud_internet_services_crn": { "$ref": "#/components/schemas/ResourceCrn" } } }, "PublicCertificateConfigurationDNSClassicInfrastructurePatch": { "title": "PublicCertificateConfigurationDNSClassicInfrastructurePatch", "x-child-schema-name": "PublicCertificateConfigurationDNSClassicInfrastructurePatch", "description": "Properties that describe the configuration update of an IBM Cloud classic infrastructure (SoftLayer).", "type": "object", "additionalProperties": false, "properties": { "classic_infrastructure_username": { "$ref": "#/components/schemas/DNSClassicInfrastructureUsername" }, "classic_infrastructure_password": { "$ref": "#/components/schemas/DNSClassicInfrastructurePassword" } } }, "ConfigurationMetadataPaginatedCollection": { "title": "ConfigurationMetadataPaginatedCollection", "description": "Properties that describe a paginated collection of secret locks.", "x-terraform-datasource-name": "sm_configurations", "x-terraform-datasource-operations": { "read": "list_configurations" }, "x-terraform-datasource-collection": "configurations", "allOf": [ { "$ref": "#/components/schemas/PaginatedCollection" }, { "$ref": "#/components/schemas/ConfigurationMetadataCollection" } ] }, "ConfigurationMetadataCollection": { "title": "ConfigurationMetadataCollection", "description": "Properties that describe a collection of configurations metadata.", "required": [ "configurations" ], "properties": { "configurations": { "description": "A collection of configuration metadata.", "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationMetadata" }, "minItems": 0, "maxItems": 1000 } } }, "ConfigurationMetadata": { "title": "ConfigurationMetadata", "description": "Your configuration metadata properties.", "anyOf": [ { "$ref": "#/components/schemas/IAMCredentialsConfigurationMetadata" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptMetadata" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSCloudInternetServicesMetadata" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSClassicInfrastructureMetadata" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationRootCAMetadata" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationIntermediateCAMetadata" }, { "$ref": "#/components/schemas/PrivateCertificateConfigurationTemplateMetadata" }, { "$ref": "#/components/schemas/CustomCredentialsConfigurationMetadata" } ], "discriminator": { "propertyName": "config_type", "mapping": { "public_cert_configuration_dns_cloud_internet_services": "#/components/schemas/PublicCertificateConfigurationDNSCloudInternetServicesMetadata", "public_cert_configuration_dns_classic_infrastructure": "#/components/schemas/PublicCertificateConfigurationDNSClassicInfrastructureMetadata", "public_cert_configuration_ca_lets_encrypt": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptMetadata", "private_cert_configuration_root_ca": "#/components/schemas/PrivateCertificateConfigurationRootCAMetadata", "private_cert_configuration_intermediate_ca": "#/components/schemas/PrivateCertificateConfigurationIntermediateCAMetadata", "private_cert_configuration_template": "#/components/schemas/PrivateCertificateConfigurationTemplateMetadata", "iam_credentials_configuration": "#/components/schemas/IAMCredentialsConfigurationMetadata", "custom_credentials_configuration": "#/components/schemas/CustomCredentialsConfigurationMetadata" } } }, "PublicCertificateConfigurationCALetsEncrypt": { "title": "PublicCertificateConfigurationCALetsEncrypt", "x-child-schema-name": "PublicCertificateConfigurationCALetsEncrypt", "description": "Properties that describe a Let's Encrypt CA configuration.", "x-resource-name": "sm_public_certificate_configuration_ca_lets_encrypt", "x-terraform-resource-name": "configuration_public_certificate_CA_Lets_Encrypt", "x-terraform-resource-id": "name", "x-terraform-resource-operations": { "create": "create_configuration", "read": "get_configuration", "update": "update_configuration", "delete": "delete_configuration" }, "x-terraform-datasource-name": "sm_public_certificate_configuration_ca_lets_encrypt", "x-terraform-datasource-operations": { "read": "get_configuration" }, "allOf": [ { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptMetadata" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptData" } ] }, "PublicCertificateConfigurationCALetsEncryptMetadata": { "title": "PublicCertificateConfigurationCALetsEncryptMetadata", "x-child-schema-name": "PublicCertificateConfigurationCALetsEncryptMetadata", "description": "Your Let's Encrypt CA metadata properties.", "allOf": [ { "$ref": "#/components/schemas/CommonConfigurationMetadata" }, { "type": "object", "required": [ "lets_encrypt_environment" ], "properties": { "lets_encrypt_environment": { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptEnvironment" }, "lets_encrypt_preferred_chain": { "$ref": "#/components/schemas/PublicCertificateConfigurationCALetsEncryptPreferredChain" } } } ] }, "PublicCertificateConfigurationDNSCloudInternetServices": { "title": "PublicCertificateConfigurationDNSCloudInternetServices", "x-child-schema-name": "PublicCertificateConfigurationDNSCloudInternetServices", "description": "Properties that describe a Cloud Internet Services DNS configuration.", "x-resource-name": "sm_public_certificate_configuration_dns_cis", "x-terraform-resource-name": "configuration_public_certificate_dns_cis", "x-terraform-resource-id": "name", "x-terraform-resource-operations": { "create": "create_configuration", "read": "get_configuration", "update": "update_configuration", "delete": "delete_configuration" }, "x-terraform-datasource-name": "sm_public_certificate_configuration_dns_cis", "x-terraform-datasource-operations": { "read": "get_configuration" }, "allOf": [ { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSCloudInternetServicesMetadata" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSCloudInternetServicesData" } ] }, "PublicCertificateConfigurationDNSCloudInternetServicesMetadata": { "title": "PublicCertificateConfigurationDNSCloudInternetServicesMetadata", "x-child-schema-name": "PublicCertificateConfigurationDNSCloudInternetServicesMetadata", "description": "Your Cloud Internet Services DNS metadata properties.", "allOf": [ { "$ref": "#/components/schemas/CommonConfigurationMetadata" } ] }, "PublicCertificateConfigurationDNSClassicInfrastructure": { "title": "PublicCertificateConfigurationDNSClassicInfrastructure", "x-child-schema-name": "PublicCertificateConfigurationDNSClassicInfrastructure", "description": "Properties that describe a Classic Infrastructure DNS configuration.", "x-resource-name": "sm_public_certificate_configuration_dns_classic_infrastructure", "x-terraform-resource-name": "configuration_public_certificate_dns_classic_infrastructure", "x-terraform-resource-id": "name", "x-terraform-resource-operations": { "create": "create_configuration", "read": "get_configuration", "update": "update_configuration", "delete": "delete_configuration" }, "x-terraform-datasource-name": "sm_public_certificate_configuration_dns_classic_infrastructure", "x-terraform-datasource-operations": { "read": "get_configuration" }, "allOf": [ { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSClassicInfrastructureMetadata" }, { "$ref": "#/components/schemas/PublicCertificateConfigurationDNSClassicInfrastructureData" } ] }, "IAMCredentialsConfiguration": { "title": "IAMCredentialsConfiguration", "x-child-schema-name": "IAMCredentialsConfiguration", "description": "Properties that describe a Classic Infrastructure DNS configuration.", "x-resource-name": "sm_iam_credentials_configuration", "x-terraform-resource-name": "configuration_iam_credentials", "x-terraform-resource-id": "name", "x-terraform-resource-operations": { "create": "create_configuration", "read": "get_configuration", "update": "update_configuration", "delete": "delete_configuration" }, "x-terraform-datasource-name": "sm_iam_credentials_configuration", "x-terraform-datasource-operations": { "read": "get_configuration" }, "allOf": [ { "$ref": "#/components/schemas/IAMCredentialsConfigurationMetadata" }, { "$ref": "#/components/schemas/IAMCredentialsConfigurationData" } ] }, "IAMCredentialsConfigurationData": { "title": "IAMCredentialsConfigurationData", "x-child-schema-name": "IAMCredentialsConfigurationData", "description": "Properties that describe an IAMCredentials configuration data.", "type": "object", "required": [ "api_key" ], "properties": { "api_key": { "$ref": "#/components/schemas/ApiKeyConfigurationRO" } } }, "IAMCredentialsConfigurationMetadata": { "title": "IAMCredentialsConfigurationMetadata", "x-child-schema-name": "IAMCredentialsConfigurationMetadata", "description": "Your IAM credentials configuration metadata properties.", "allOf": [ { "$ref": "#/components/schemas/CommonConfigurationMetadata" }, { "type": "object", "properties": { "disabled": { "$ref": "#/components/schemas/IAMCredentialsConfigurationDisabledRO" } } } ] }, "CustomCredentialsConfigurationMetadata": { "title": "CustomCredentialsConfigurationMetadata", "x-child-schema-name": "CustomCredentialsConfigurationMetadata", "description": "Your custom credentials configuration metadata properties.", "allOf": [ { "$ref": "#/components/schemas/CommonConfigurationMetadata" }, { "type": "object", "required": [ "code_engine", "schema" ], "properties": { "code_engine_key_ref": { "$ref": "#/components/schemas/CodeEngineKeyRef" }, "api_key_ref": { "$ref": "#/components/schemas/CustomCredentialsConfigurationApiKey" }, "code_engine": { "$ref": "#/components/schemas/CustomCredentialsConfigurationCodeEngine" }, "schema": { "$ref": "#/components/schemas/CustomCredentialsConfigurationSchema" }, "task_timeout": { "$ref": "#/components/schemas/TaskTimeout" } } } ] }, "CustomCredentialsConfiguration": { "title": "CustomCredentialsConfiguration", "x-child-schema-name": "CustomCredentialsConfiguration", "description": "The configuration of custom credentials.", "x-resource-name": "sm_custom_credentials_configuration", "x-terraform-resource-name": "configuration_custom_credentials", "x-terraform-resource-id": "name", "x-terraform-resource-operations": { "create": "create_configuration", "read": "get_configuration", "update": "update_configuration", "delete": "delete_configuration" }, "x-terraform-datasource-name": "sm_custom_credentials_configuration", "x-terraform-datasource-operations": { "read": "get_configuration" }, "allOf": [ { "$ref": "#/components/schemas/CustomCredentialsConfigurationMetadata" } ] }, "PublicCertificateConfigurationDNSClassicInfrastructureMetadata": { "title": "PublicCertificateConfigurationDNSClassicInfrastructureMetadata", "x-child-schema-name": "PublicCertificateConfigurationDNSClassicInfrastructureMetadata", "description": "Your Classic Infrastructure DNS metadata properties.", "allOf": [ { "$ref": "#/components/schemas/CommonConfigurationMetadata" } ] }, "NotificationsRegistrationPrototype": { "description": "The details of the Event Notifications registration request.", "title": "NotificationsRegistrationPrototype", "x-child-schema-name": "NotificationsRegistrationPrototype", "x-resource-name": "sm_en_registration", "x-terraform-resource-id": "event_notifications_instance_crn", "x-terraform-resource-name": "en_registration", "x-terraform-resource-operations": { "create": "create_notifications_registration", "read": "get_notifications_registration", "delete": "delete_notifications_registration", "update": "create_notifications_registration" }, "type": "object", "additionalProperties": false, "required": [ "event_notifications_instance_crn", "event_notifications_source_name" ], "properties": { "event_notifications_instance_crn": { "$ref": "#/components/schemas/ResourceCrn" }, "event_notifications_source_name": { "$ref": "#/components/schemas/EventNotificationsSourceName" }, "event_notifications_source_description": { "$ref": "#/components/schemas/EventNotificationsSourceDescription" } } }, "NotificationsRegistration": { "description": "The details of the Event Notifications registration.", "title": "NotificationsRegistration", "x-terraform-datasource-name": "sm_en_registration", "x-terraform-datasource-operations": { "read": "get_notifications_registration" }, "x-child-schema-name": "NotificationsRegistration", "type": "object", "required": [ "event_notifications_instance_crn" ], "properties": { "event_notifications_instance_crn": { "$ref": "#/components/schemas/ResourceCrn" } } }, "EventNotificationsSourceName": { "type": "string", "description": "The name that is displayed as a source that is in your Event Notifications instance.", "pattern": "(.*?)", "minLength": 2, "maxLength": 256, "example": "My Secrets Manager" }, "EventNotificationsSourceDescription": { "type": "string", "description": "An optional description for the source that is in your Event Notifications instance.", "pattern": "(.*?)", "minLength": 0, "maxLength": 1024, "example": "Sends notification lifecycle events." }, "PasswordPolicyLength": { "description": "The length of auto-generated passwords.", "type": "integer", "format": "int32", "minimum": 12, "maximum": 256, "default": 32 }, "PasswordPolicyLengthNoDefault": { "description": "The length of auto-generated passwords.", "type": "integer", "format": "int32", "minimum": 12, "maximum": 256 }, "PasswordIncludeDigits": { "description": "Include digits in auto-generated passwords.", "type": "boolean", "default": true }, "PasswordIncludeDigitsNoDefault": { "description": "Include digits in auto-generated passwords.", "type": "boolean" }, "PasswordIncludeSymbols": { "description": "Include symbols in auto-generated passwords.", "type": "boolean", "default": true }, "PasswordIncludeSymbolsNoDefault": { "description": "Include symbols in auto-generated passwords.", "type": "boolean" }, "PasswordIncludeUppercase": { "description": "Include uppercase letters in auto-generated passwords.", "type": "boolean", "default": true }, "PasswordIncludeUppercaseNoDefault": { "description": "Include uppercase letters in auto-generated passwords.", "type": "boolean" }, "CustomCredentialsFields": { "title": "CustomCredentialsFields", "description": "The fields that can be passed to and from the custom credentials engine. Allowed types are string, integer, and boolean.", "x-child-schema-name": "CustomCredentialsFields", "type": "object", "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/CustomCredentialsFieldString" }, { "$ref": "#/components/schemas/CustomCredentialsFieldInteger" }, { "$ref": "#/components/schemas/CustomCredentialsFieldBoolean" } ] } }, "CustomCredentialsParameters": { "title": "CustomCredentialsParameters", "x-cli-option-name": "custom-credentials-parameters", "description": "The parameters that are passed to custom credentials engine. Allowed types are string, integer, and boolean.", "x-child-schema-name": "CustomCredentialsParameters", "type": "object", "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/CustomCredentialsFieldString" }, { "$ref": "#/components/schemas/CustomCredentialsFieldInteger" }, { "$ref": "#/components/schemas/CustomCredentialsFieldBoolean" } ] } }, "CustomCredentialsFieldString": { "title": "CustomCredentialsFieldString", "type": "string", "pattern": "^(.*?)$", "maxLength": 100000, "example": "username", "description": "A string value (can be any string).", "x-cli-description": "A string value (can be any string)." }, "CustomCredentialsFieldInteger": { "title": "CustomCredentialsFieldInteger", "type": "integer", "minimum": -9007199254740992, "maximum": 9007199254740991, "example": 1234, "description": "An integer value.", "x-cli-description": "An integer value." }, "CustomCredentialsFieldBoolean": { "title": "CustomCredentialsFieldBoolean", "type": "boolean", "example": true, "description": "A boolean value.", "x-cli-description": "A boolean value." }, "Error": { "title": "Error", "description": "API Error", "type": "object", "additionalProperties": false, "minProperties": 2, "maxProperties": 3, "required": [ "code", "message" ], "properties": { "code": { "description": "An error code identifier.", "type": "string", "enum": [ "unauthorized", "access_forbidden", "internal_server_error", "too_many_requests", "payment_required", "bad_request", "bad_gateway", "not_found", "gone", "conflict", "multiple_choices", "resource_create_error", "resource_get_error", "resource_update_error", "resource_delete_error", "not_implemented", "precondition_failed", "service_unavailable", "unprocessable_entity" ] }, "message": { "description": "A human-readable message that provides details about the error.", "type": "string", "minLength": 0, "maxLength": 4096 }, "more_info": { "description": "A publicly-accessible URL where information about the error can be read in a web browser.", "type": "string", "minLength": 0, "maxLength": 128 } } }, "ErrorStatusCode": { "title": "ErrorStatusCode", "description": "The HTTP status code used for the response.", "type": "integer", "format": "int32", "minimum": 300, "maximum": 503, "enum": [ 300, 400, 401, 402, 403, 404, 409, 410, 422, 500, 501, 502, 503 ] }, "ErrorCollection": { "title": "ErrorCollection", "description": "A collection of errors.", "type": "object", "required": [ "errors" ], "additionalProperties": false, "minProperties": 2, "maxProperties": 3, "properties": { "trace": { "$ref": "#/components/schemas/Uuid" }, "status_code": { "$ref": "#/components/schemas/ErrorStatusCode" }, "errors": { "title": "ErrorCollection", "description": "A collection of errors.", "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "minItems": 1, "maxItems": 100 } } } }, "responses": { "NotImplemented": { "description": "The specified api is not implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "NotImplemented": { "$ref": "#/components/examples/NotImplemented" } } } } }, "NotFound": { "description": "The specified resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFound" } } } } }, "Gone": { "description": "The specified resource no longer exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "Gone": { "$ref": "#/components/examples/Gone" } } } } }, "Unauthorized": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "Unauthorized": { "$ref": "#/components/examples/Unauthorized" } } } } }, "BadRequest": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "BadRequest": { "$ref": "#/components/examples/BadRequest" } } } } }, "PaymentRequired": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "PaymentRequired": { "$ref": "#/components/examples/PaymentRequired" } } } } }, "Forbidden": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "Forbidden": { "$ref": "#/components/examples/Forbidden" } } } } }, "InternalServerError": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "InternalServerError": { "$ref": "#/components/examples/InternalServerError" } } } } }, "BadGatewayError": { "description": "BadGatewayError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "BadGatewayError": { "$ref": "#/components/examples/BadGatewayError" } } } } }, "ServiceUnavailableError": { "description": "ServiceUnavailableError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "ServiceUnavailableError": { "$ref": "#/components/examples/ServiceUnavailableError" } } } } }, "MultipleChoices": { "description": "MultipleChoices", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "MultipleChoices": { "$ref": "#/components/examples/MultipleChoices" } } } } }, "Conflict": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "Conflict": { "$ref": "#/components/examples/Conflict" } } } } }, "UnprocessableEntity": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "examples": { "UnprocessableEntity": { "$ref": "#/components/examples/UnprocessableEntity" } } } } } }, "examples": { "SecretGroup": { "description": "Example of `SecretGroup` response", "value": { "created_at": "2020-10-05T21:33:11Z", "description": "Extended description for this group.", "id": "d898bb90-82f6-4d61-b5cc-b079b66cfa76", "name": "my-secret-group", "updated_at": "2020-11-25T22:13:10Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21" } }, "SecretGroupCollection": { "description": "Example `SecretGroup` collection response", "value": { "secret_groups": [ { "created_at": "2020-09-05T21:33:11Z", "description": "Default Secret Group", "id": "ee52ebb6-1728-4580-8ede-13f6504e3ae0", "name": "default", "updated_at": "2020-09-25T22:13:10Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21" }, { "created_at": "2020-10-05T21:33:11Z", "description": "Extended description for this group.", "id": "cb52ebb6-1728-4580-8ede-13f6504e3ae0", "name": "my-secret-group", "updated_at": "2020-11-25T22:13:10Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21" }, { "created_at": "2020-10-05T22:05:15Z", "description": "Extended description for this group.", "id": "19f88b9c-4f2f-405c-b877-a09338575c3f", "name": "my-second-secret-group", "updated_at": "2020-11-25T22:13:10Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21" } ], "total_count": 3 } }, "ImportedCertificatePrototype": { "description": "Example of imported certificate's request body", "value": { "name": "example-imported-certificate", "description": "Description of my imported certificate.", "secret_type": "imported_cert", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "labels": [ "dev", "us-south" ], "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "intermediate": "-----BEGIN CERTIFICATE-----\nMIIE3DCCBGKgAwIBAgIUKncnp6BdSUKAFGBcP4YVp/gTb7gwCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END RSA PRIVATE KEY-----", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ImportedCertificateManagedCsrCreatePrototype": { "description": "Example of imported certificate managed csr's request body", "value": { "name": "example-imported-certificate-managed-csr", "description": "Description of my imported certificate.", "secret_type": "imported_cert", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "labels": [ "dev", "us-south" ], "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "managed_csr": { "require_cn": true, "common_name": "example.com", "alt_names": "alt-name-1,alt-name-2", "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": "2.5.4.5;UTF8:*.example.com", "exclude_cn_from_sans": false, "key_type": "rsa", "key_bits": 2048, "user_ids": "user-1,user-2" } } }, "KVSecretPrototype": { "description": "Example of a KV secret's request body.", "value": { "name": "example-kv-secret", "description": "Description of my key-value secret.", "secret_type": "kv", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "labels": [ "dev", "us-south" ], "data": { "key1": "val1", "key2": "val2" }, "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "PublicCertificatePrototype": { "description": "Example of a public certificate's request body.", "value": { "name": "example-public-certificate", "description": "Description of my public certificate.", "secret_type": "public_cert", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "labels": [ "dev", "us-south" ], "common_name": "example.com", "key_algorithm": "RSA2048", "alt_names": [ "s1.example.com", "*.s2.example.com" ], "ca": "lets-encrypt-config", "dns": "cloud-internet-services-config", "rotation": { "auto_rotate": true, "rotate_keys": true }, "bundle_certs": true, "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "IAMCredentialsSecretAccessGroupPrototype": { "description": "Example of an IAM credentials secret request body.", "value": { "name": "example-iam-credentials-secret", "description": "Description of my IAM credentials secret.", "secret_type": "iam_credentials", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "labels": [ "dev", "us-south" ], "ttl": "30m", "access_groups": [ "AccessGroupId-45884031-54be-4dd7-86ff-112511e92699", "AccessGroupId-8c0ed733-dfee-4a94-992b-e2247b86e2a2" ], "reuse_api_key": false, "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "IAMCredentialsSecretServiceIDPrototype": { "description": "Example IAM Credentials secret with a service ID request body.", "value": { "name": "example-iam-credentials-secret", "description": "description of my IAM Credentials secret.", "secret_type": "iam_credentials", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "labels": [ "dev", "us-south" ], "ttl": "30m", "service_id": "ServiceId-bb4ccc31-bd31-493a-bb58-52ec399800be", "reuse_api_key": true, "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "CustomCredentialsSecretPrototype": { "description": "A sample request body for a custom credentials secret.", "value": { "name": "example-custom-credentials-secret", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "custom_credentials", "configuration": "my_config", "description": "The description for my custom credentials secret.", "parameters": { "user_name": "username", "scope": "admin" }, "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "labels": [ "dev", "us-south" ], "rotation": { "auto_rotate": true, "interval": 60, "unit": "day" }, "ttl": "90d", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ArbitrarySecretPrototype": { "description": "Example of arbitrary secret's request body.", "value": { "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", "payload": "secret-data", "secret_group_id": "default", "secret_type": "arbitrary", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ServiceCredentialsSecretPrototype": { "description": "A sample request body for a service credentials secret.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "The description for my service credentials secret.", "labels": [ "dev", "us-south" ], "name": "example-service-credentials-secret", "rotation": { "auto_rotate": true, "interval": 60, "unit": "day" }, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "service_credentials", "source_service": { "instance": { "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce::" }, "parameters": { "HMAC": true, "serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/22018f3c34ff4ff193698d15ca316946::serviceid:ServiceId-6183f10e-6db1-44e8-806c-cfb711b87feb" }, "role": { "crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" } }, "ttl": "90d", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "UsernamePasswordSecretPrototype": { "description": "Example of user credentials secret's request body", "value": { "name": "example-username-password-secret", "description": "Description of my user credentials secret", "secret_type": "username_password", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "labels": [ "dev", "us-south" ], "username": "example-username", "password": "example-password", "rotation": { "auto_rotate": true, "interval": 10, "unit": "day" }, "password_generation_policy": { "length": 32, "include_digits": true, "include_symbols": true, "include_uppercase": true }, "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ImportedCertificateMetadata": { "description": "Example of imported certificate's metadata", "value": { "alt_names": [ "s1.example.com", "*.s2.example.com" ], "common_name": "example.com", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "created_at": "2022-06-27T11:58:15Z", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:bc656587-8fda-4d05-9ad8-b1de1ec7e712", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Description of my imported certificate.", "downloaded": true, "retrieved_at": "2025-07-27T12:34:15Z", "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "intermediate_included": true, "issuer": "GlobalSign", "key_algorithm": "RSA2048", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-imported-certificate", "private_key_included": true, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_type": "imported_cert", "serial_number": "38:eb:01:a3:22:e9:de:55:24:56:9b:14:cb:e2:f3:e3:e2:fb:f5:18", "signing_algorithm": "SHA256-RSA", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "validity": { "not_before": "2022-06-27T11:58:15Z", "not_after": "2030-10-05T11:49:42Z" }, "versions_total": 1 } }, "ImportedCertificateManagedCsrMetadata": { "description": "Example of imported certificate's metadata", "value": { "alt_names": [ "alt-name-1", "alt-name-2", "alt-name-3" ], "common_name": "example.com", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "created_at": "2022-06-27T11:58:15Z", "retrieved_at": "2022-06-27T12:34:15Z", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:bc656587-8fda-4d05-9ad8-b1de1ec7e712", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Description of my imported certificate.", "downloaded": true, "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "intermediate_included": true, "issuer": "GlobalSign", "key_algorithm": "RSA2048", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-imported-certificate", "managed_csr": { "require_cn": true, "common_name": "example.com", "alt_names": "alt-name-1,alt-name-2,alt-name-3", "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": "2.5.4.5;UTF8:*.example.com", "exclude_cn_from_sans": false, "server_flag": true, "client_flag": true, "code_signing_flag": false, "email_protection_flag": false, "ou": [], "organization": [], "country": [], "locality": [], "province": [], "street_address": [], "postal_code": [], "key_type": "rsa", "key_bits": 2048, "user_ids": "user-1,user-2", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICiDGGAXACAQAwGDEWMBQGA1UEAxMNct5ANo8jybxCwNjHBB==\n-----END CERTIFICATE REQUEST-----", "private_key": "obfuscated", "rotate_keys": true }, "private_key_included": true, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_type": "imported_cert", "serial_number": "38:eb:01:a3:22:e9:de:55:24:56:9b:14:cb:e2:f3:e3:e2:fb:f5:18", "signing_algorithm": "SHA256-RSA", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "validity": { "not_before": "2022-06-27T11:58:15Z", "not_after": "2030-10-05T11:49:42Z" }, "versions_total": 1 } }, "UsernamePasswordMetadata": { "description": "Example of the metadata of a user's credentials.", "value": { "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "retrieved_at": "2025-06-27T12:34:15Z", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:bc656587-8fda-4d05-9ad8-b1de1ec7e712", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Description of my user credentials secret.", "downloaded": true, "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-username-password-secret", "rotation": { "auto_rotate": false }, "password_generation_policy": { "length": 32, "include_digits": true, "include_symbols": true, "include_uppercase": true }, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_type": "username_password", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "versions_total": 1 } }, "ServiceCredentialsSecretMetadata": { "description": "A sample metadata body for a service credentials secret.", "value": { "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:bc656587-8fda-4d05-9ad8-b1de1ec7e712", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "The description for my service credentials secret.", "downloaded": true, "retrieved_at": "2025-07-27T12:34:15Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-service-credentials-secret", "next_rotation_date": "2022-10-10T21:33:11Z", "rotation": { "auto_rotate": true, "interval": 60, "unit": "day" }, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "service_credentials", "source_service": { "instance": { "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce::" }, "parameters": { "HMAC": true, "serviceid_crn": "existing sid" }, "role": { "crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "iam": { "apikey": { "description": "Auto-generated for key af56af3a-f56a-4c73-8afe-a662c47840b3", "id": "ApiKey-6d1f818f-0ceb-4353-ac36-b1d6421c5898", "name": "6d1f818f-0ceb-4353-ad37-b1d6421c5898" }, "role": { "crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "serviceid": { "crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" } }, "resource_key": { "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/22018f3c34ff4ff193698d15ca316946:871d0a4d-feb1-4cb0-8dc1-77c78cee8aab:resource-key:af56af3a-f56a-4c73-8afe-a662c47840b3", "name": "secret_name_versionid" } }, "state": 1, "state_description": "active", "ttl": "90d", "updated_at": "2022-10-05T21:33:11Z", "version_custom_metadata": { "custom_version_key": "custom_version_value" }, "versions_total": 1 } }, "PublicCertificateMetadata": { "description": "Example of public certificates' metadata", "value": { "alt_names": [ "s1.example.com", "*.s2.example.com" ], "common_name": "example.com", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "created_at": "2022-10-06T06:15:55Z", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description of my public certificate.", "downloaded": true, "retrieved_at": "2025-07-27T12:34:15Z", "expiration_date": "2030-10-05T11:49:42Z", "id": "f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "issuance_info": { "auto_rotated": false, "ordered_on": "2022-10-06T06:15:55Z", "state": 1, "state_description": "active" }, "bundle_certs": true, "ca": "lets-encrypt-config", "dns": "cloud-internet-services-config", "issuer": "Lets Encrypt", "key_algorithm": "RSA2048", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "my-public-certificate", "rotation": { "auto_rotate": true, "rotate_keys": true }, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "public_cert", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd", "signing_algorithm": "SHA256-RSA", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "validity": { "not_before": "2020-10-05T21:33:11Z", "not_after": "2030-10-05T11:49:42Z" }, "versions_total": 1 } }, "PublicCertificateCreated": { "description": "Example of created public certificate", "value": { "alt_names": [ "s1.example.com", "*.s2.example.com" ], "common_name": "example.com", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "created_at": "2022-10-06T06:15:55Z", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description of my public certificate.", "downloaded": false, "id": "f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "issuance_info": { "auto_rotated": false, "ordered_on": "2022-10-06T06:15:55Z", "state": 0, "state_description": "pre_activation" }, "bundle_certs": true, "ca": "lets-encrypt-config", "dns": "cloud-internet-services-config", "key_algorithm": "RSA2048", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "my-public-certificate", "rotation": { "auto_rotate": true, "rotate_keys": true }, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "public_cert", "state": 0, "state_description": "pre_activation", "updated_at": "2022-10-06T06:15:55Z", "versions_total": 1 } }, "KVSecretMetadata": { "description": "Example of KV secret's metadata", "value": { "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description of my key-value secret..", "downloaded": true, "retrieved_at": "2025-07-27T12:34:15Z", "expiration_date": "2030-10-05T11:49:42Z", "id": "f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "my-kv-secret", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "kv", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "versions_total": 1 } }, "UsernamePasswordSecretMetadata": { "description": "Example of user credentials' metadata", "value": { "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description for my user credentials secret.", "downloaded": true, "expiration_date": "2030-10-05T11:49:42Z", "id": "f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "my-username-password-secret", "rotation": { "auto_rotate": true, "interval": 30, "unit": "day" }, "password_generation_policy": { "length": 32, "include_digits": true, "include_symbols": true, "include_uppercase": true }, "retrieved_at": "1970-01-01T00:00:00Z", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "username_password", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "versions_total": 1 } }, "ArbitrarySecretMetadata": { "description": "Example of arbitrary secret's metadata", "value": { "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:cb7a2502-8ede-47d6-b5b6-1b7af6b6f563", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Description of my arbitrary secret.", "downloaded": true, "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-arbitrary-secret", "retrieved_at": "1970-01-01T00:00:00Z", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_type": "arbitrary", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "versions_total": 1 } }, "ImportedCertificate": { "description": "Example imported certificate", "value": { "alt_names": [ "s1.example.com", "*.s2.example.com" ], "common_name": "example.com", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "created_at": "2020-10-05T21:33:11Z", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:bc656587-8fda-4d05-9ad8-b1de1ec7e712", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Description of my imported certificate.", "downloaded": false, "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "intermediate_included": true, "issuer": "GlobalSign", "key_algorithm": "RSA2048", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-imported-certificate", "private_key_included": true, "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "intermediate": "-----BEGIN CERTIFICATE-----\nMIIE3DCCBGKgAwIBAgIUKncnp6BdSUKAFGBcP4YVp/gTb7gwCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END RSA PRIVATE KEY-----", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "imported_cert", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd", "signing_algorithm": "SHA256-RSA", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "validity": { "not_before": "2020-10-05T21:33:11Z", "not_after": "2030-10-05T11:49:42Z" }, "versions_total": 1 } }, "ImportedCertificateManagedCsrCreate": { "description": "Example response for imported certificate create", "value": { "managed_csr": { "require_cn": true, "common_name": "example.com", "alt_names": "alt-name-1,alt-name-2", "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": "2.5.4.5;UTF8:*.example.com", "exclude_cn_from_sans": false, "server_flag": true, "client_flag": true, "code_signing_flag": false, "email_protection_flag": false, "ou": [], "organization": [], "country": [], "locality": [], "province": [], "street_address": [], "postal_code": [], "key_type": "rsa", "key_bits": 2048, "user_ids": "user-1,user-2", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICiDCCAXACAQAwGDEWMBQGA1UEAxMNct5ANo8jybxCwNjHOA==\n-----END CERTIFICATE REQUEST-----", "private_key": "obfuscated" }, "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "created_at": "2020-10-05T21:33:11Z", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:bc656587-8fda-4d05-9ad8-b1de1ec7e712", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Description of my imported certificate.", "downloaded": false, "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-imported-certificate-managed-csr", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "imported_cert", "state": 0, "state_description": "pre_activation", "updated_at": "2022-10-05T21:33:11Z", "versions_total": 0 } }, "ArbitrarySecret": { "description": "Example of an arbitrary secret.", "value": { "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:cb7a2502-8ede-47d6-b5b6-1b7af6b6f563", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Description of my arbitrary secret.", "downloaded": true, "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-arbitrary-secret", "payload": "secret-data", "retrieved_at": "1970-01-01T00:00:00Z", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_type": "arbitrary", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "versions_total": 1 } }, "PublicCertificate": { "description": "Example public certificate", "value": { "alt_names": [ "s1.example.com", "*.s2.example.com" ], "common_name": "example.com", "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description for this secret.", "downloaded": false, "expiration_date": "2030-10-05T11:49:42Z", "id": "f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "issuer": "Lets Encrypt", "issuance_info": { "auto_rotated": false, "ordered_on": "2022-10-06T06:15:55Z", "state": 1, "state_description": "active" }, "bundle_certs": true, "ca": "lets-encrypt-config", "dns": "cloud-internet-services-config", "key_algorithm": "RSA2048", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "my-public-certificate", "retrieved_at": "1970-01-01T00:00:00Z", "rotation": { "auto_rotate": true, "rotate_keys": true }, "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "intermediate": "-----BEGIN CERTIFICATE-----\nMIIE3DCCBGKgAwIBAgIUKncnp6BdSUKAFGBcP4YVp/gTb7gwCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END RSA PRIVATE KEY-----", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd", "secret_type": "public_cert", "signing_algorithm": "SHA256-RSA", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "validity": { "not_before": "2020-10-05T21:33:11Z", "not_after": "2030-10-05T11:49:42Z" }, "versions_total": 1 } }, "UsernamePasswordSecret": { "description": "Example user credentials", "value": { "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:bc656587-8fda-4d05-9ad8-b1de1ec7e712", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Description of my user credentials secret.", "downloaded": true, "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-username-password", "next_rotation_date": "2025-10-10T21:33:11Z", "retrieved_at": "2025-07-27T12:34:15Z", "rotation": { "auto_rotate": true, "interval": 1, "unit": "day" }, "password_generation_policy": { "length": 32, "include_digits": true, "include_symbols": true, "include_uppercase": true }, "username": "admin", "password": "admin1234", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_type": "username_password", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "versions_total": 1 } }, "ServiceCredentialsSecret": { "description": "A sample service credentials secret body.", "value": { "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "credentials": { "apikey": "2epu_ykv0PMp2MhxQmDMn7VzrkSlBwi6BOI8uthi_RCS", "cos_hmac_keys": { "access_key_id": "af56af3af56a4c738afea662c47840b3", "secret_access_key": "bc69b010402011eebe560242ac120002aedc950c7ea6ac4d" }, "endpoints": "https://control.cloud-object-storage.cloud.ibm.com/v2/endpoints", "iam_apikey_description": "Auto-generated for key 6d1f818f-0ceb-4353-ac36-b1d6421c5898", "iam_apikey_id": "ApiKey-6d1f818f-0ceb-4353-ac36-b1d6421c5898", "iam_apikey_name": "6d1f818f-0ceb-4353-ac36-b1d6421c5898", "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/22018f3c34ff4ff193698d15ca311234::serviceid:ServiceId-6183f10e-6db1-44e8-806c-cfb711b81234", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/22018f3c34ff4ff193698d15ca311234:871d0a4d-feb1-4cb0-8dc1-77c78cee1234::" }, "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:bc656587-8fda-4d05-9ad8-b1de1ec7e712", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "The description for my service credentials secret.", "downloaded": false, "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-service-credentials-secret", "next_rotation_date": "2022-10-10T21:33:11Z", "rotation": { "auto_rotate": true, "interval": 60, "unit": "day" }, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "service_credentials", "source_service": { "instance": { "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce::" }, "parameters": { "HMAC": true, "serviceid_crn": "existing sid" }, "role": { "crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "iam": { "apikey": { "description": "Auto-generated for key af56af3a-f56a-4c73-8afe-a662c47840b3", "id": "ApiKey-6d1f818f-0ceb-4353-ac36-b1d6421c5898", "name": "6d1f818f-0ceb-4353-ad37-b1d6421c5898" }, "role": { "crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "serviceid": { "crn": "crn:v1:bluemix:public:iam-identity::a/22018f3c34ff4ff193698d15ca311234::serviceid:ServiceId-6183f10e-6db1-44e8-806c-cfb711b81234" }, "resource_key": { "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/22018f3c34ff4ff193698d15ca311234:871d0a4d-feb1-4cb0-8dc1-77c78cee1234:resource-key:af56af3a-f56a-4c73-8afe-a662c47840b3", "name": "secret_name_versionid" } } }, "state": 1, "state_description": "active", "ttl": "90d", "updated_at": "2022-10-05T21:33:11Z", "version_custom_metadata": { "custom_version_key": "custom_version_value" }, "versions_total": 1 } }, "CustomCredentialsSecretCreated": { "description": "A sample custom credentials secret body.", "value": { "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:bc656587-8fda-4d05-9ad8-b1de1ec7e712", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "The description for my custom credentials secret.", "downloaded": false, "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-custom-credentials-secret", "parameters": { "key1": "value1", "key2": true, "key3": 10 }, "configuration": "custom_credentials_configuration_name", "queued_task_count": 1, "task_count": 1, "next_rotation_date": "2022-10-10T21:33:11Z", "rotation": { "auto_rotate": true, "interval": 60, "unit": "day" }, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "custom_credentials", "state": 0, "state_description": "pre_activation", "ttl": "90d", "updated_at": "2025-03-05T13:24:35Z", "version_custom_metadata": { "custom_version_key": "custom_version_value" }, "versions_total": 0 } }, "CustomCredentialsSecret": { "description": "A sample custom credentials secret body.", "value": { "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:bc656587-8fda-4d05-9ad8-b1de1ec7e712", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "The description for my custom credentials secret.", "downloaded": true, "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-custom-credentials-secret", "parameters": { "key1": "value1", "key2": true, "key3": 10 }, "configuration": "custom_credentials_configuration_name", "processing_task_id": "sm-task-688b4c23-c084-d44f-b84e-ae89f280995b", "queued_task_count": 0, "task_count": 1, "next_rotation_date": "2022-10-10T21:33:11Z", "retrieved_at": "1970-01-01T00:00:00Z", "rotation": { "auto_rotate": true, "interval": 60, "unit": "day" }, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_type": "custom_credentials", "state": 0, "state_description": "pre_activation", "ttl": "90d", "updated_at": "2025-03-05T13:24:35Z", "version_custom_metadata": { "custom_version_key": "custom_version_value" }, "versions_total": 1, "credentials_content": { "token": "xF9v7OztItL5DOnFgHfS9NCT1sLTUew8KYZcZfxI" } } }, "KVSecret": { "description": "Example kv secret", "value": { "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:cb7a2502-8ede-47d6-b5b6-1b7af6b6f563", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Description of my key-value secret.", "downloaded": true, "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-kv-secret", "data": { "key1": "val1" }, "retrieved_at": "2022-11-06T17:44:22Z", "secret_type": "kv", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "versions_total": 1 } }, "IAMCredentialsSecretPrototypeResponse": { "description": "Example create IAM Credentials using Service ID", "value": { "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:24ec2c34-38ee-4038-9f1d-9a629423158d", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description for this secret.", "downloaded": false, "id": "24ec2c34-38ee-4038-9f1d-9a629423158d", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-iam-credentials-secret", "reuse_api_key": false, "secret_group_id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "secret_type": "iam_credentials", "service_id": "ServiceId-bb4ccc31-bd31-493a-bb58-52ec399800be", "service_id_is_static": false, "state": 1, "state_description": "active", "ttl": "1800", "updated_at": "2020-10-05T21:33:11Z", "versions_total": 1 } }, "IAMCredentialsSecret": { "description": "Example IAM Credentials using Service ID", "value": { "api_key_id": "ApiKey-dcd0b857-b590-4507-8c64-ae89a23e8d76", "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:24ec2c34-38ee-4038-9f1d-9a629423158d", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description for this secret.", "downloaded": true, "expiration_date": "2021-01-01T00:00:00Z", "id": "24ec2c34-38ee-4038-9f1d-9a629423158d", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-iam-credentials-secret", "reuse_api_key": false, "api_key": "RmnPBn6n1dzoo0v3kyznKEpg0WzdTpW9lW7FtKa017_u", "retrieved_at": "2020-10-05T21:33:11Z", "secret_group_id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "secret_type": "iam_credentials", "service_id": "ServiceId-bb4ccc31-bd31-493a-bb58-52ec399800be", "service_id_is_static": false, "state": 1, "state_description": "active", "ttl": "1800", "updated_at": "2020-10-05T21:33:11Z", "versions_total": 1 } }, "IAMCredentialsSecretMetadata": { "description": "Example IAM Credentials metadata", "value": { "access_groups": [ "AccessGroupId-45884031-54be-4dd7-86ff-112511e92699" ], "api_key_id": "ApiKey-dcd0b857-b590-4507-8c64-ae89a23e8d76", "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:24ec2c34-38ee-4038-9f1d-9a629423158d", "description": "Extended description for this secret.", "downloaded": true, "expiration_date": "2021-01-01T00:00:00Z", "id": "24ec2c34-38ee-4038-9f1d-9a629423158d", "labels": [ "dev", "us-south" ], "locks_total": 2, "name": "example-iam-credentials-secret", "retrieved_at": "2020-10-05T21:33:11Z", "reuse_api_key": false, "secret_group_id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "secret_type": "iam_credentials", "service_id": "ServiceId-bb4ccc31-bd31-493a-bb58-52ec399800be", "service_id_is_static": false, "state": 1, "state_description": "active", "ttl": "1800", "updated_at": "2020-10-05T21:33:11Z", "versions_total": 1 } }, "IAMCredentialsSecretMetadataPatch": { "description": "Example update input of IAM Credentials metadata", "value": { "custom_metadata": { "key": "value" }, "description": "Description of updated IAM Credentials.", "labels": [ "dev", "us-south" ], "name": "updated-iam-credentials-name", "ttl": "12h" } }, "CustomCredentialsSecretMetadata": { "description": "Example custom credentials metadata", "value": { "created_by": "IBMid-270002CM7E", "created_at": "2025-04-02T13:18:12Z", "crn": "crn:v1:staging:public:secrets-manager:us-south:a/123f5fb10986423e97aabbccf18b7e00:1234f76e-9563-40f1-81e3-8fabc7344383:secret:245e1fd2-0aff-e41d-3e38-34418bc4a797", "id": "245e1fd2-0aff-e41d-3e38-34418bc4a797", "name": "customCredentialsSecret", "secret_group_id": "default", "secret_type": "custom_credentials", "state": 1, "state_description": "active", "updated_at": "2025-04-02T13:18:13Z", "custom_metadata": {}, "labels": [], "downloaded": false, "locks_total": 0, "versions_total": 1, "description": "secret description", "ttl": "90d", "retrieved_at": "1970-01-01T00:00:00Z", "rotation": { "auto_rotate": true, "interval": 60, "unit": "day" }, "parameters": { "scope": "admin", "user_name": "other" }, "configuration": "my_config", "queued_tasks": 0, "task_count": 1 } }, "ImportedCertificateMetadataPatch": { "description": "Example update input of imported certificate metadata", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "updated imported certificate description", "labels": [ "dev", "us-south" ], "name": "updated-imported-certificate-name" } }, "ImportedCertificateManagedCsrMetadataPatch": { "description": "Example update input of imported certificate metadata.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Updated imported certificate description.", "managed_csr": { "alt_names": "alt-name-1,alt-name-2,alt-name-3", "rotate_keys": true } } }, "IAMCredentialsConfigurationPatch": { "description": "Update IAM Credentials configuration.", "value": { "api_key": "RmnPBn6n1dzoo0v3kyznKEpg0WzdTpW9lW7FtKa017_u" } }, "CustomCredentialsConfigurationPatch": { "description": "Update custom credentials configuration.", "value": { "task_timeout": "10m" } }, "KVSecretMetadataPatch": { "description": "Example of an updated input of KV secret metadata.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Updated KV secret description.", "labels": [ "dev", "us-south" ], "name": "updated-kv-secret-name" } }, "UsernamePasswordSecretMetadataPatch": { "description": "Example update input of user credentials secrets' metadata.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Updated username password description.", "labels": [ "dev", "us-south" ], "name": "updated-username-password-name", "rotation": { "auto_rotate": true, "interval": 30, "unit": "day" }, "password_generation_policy": { "length": 32, "include_digits": true, "include_symbols": true, "include_uppercase": true } } }, "ServiceCredentialsSecretMetadataPatch": { "description": "A sample update input for the metadata of a service credentials secret.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "The updated service credentials secret description.", "labels": [ "dev", "us-south" ], "name": "updated-service-credentials-secret-name", "rotation": { "auto_rotate": true, "interval": 30, "unit": "day" } } }, "CustomCredentialsSecretMetadataPatch": { "description": "A sample update input for the metadata of a custom credentials secret.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "The updated custom credentials secret description.", "labels": [ "dev", "us-south" ], "name": "updated-custom-credentials-secret-name", "rotation": { "auto_rotate": true, "interval": 60, "unit": "day" }, "ttl": "90d", "parameters": { "user_name": "username", "scope": "admin" } } }, "PublicCertificateMetadataPatch": { "description": "Example update input of public certificate metadata", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "updated public certificate description", "labels": [ "dev", "us-south" ], "name": "updated-public-certificate-name", "rotation": { "auto_rotate": true, "rotate_keys": true } } }, "ArbitrarySecretMetadataPatch": { "description": "Example update input of arbitrary secret", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "updated Arbitrary Secret description", "labels": [ "dev", "us-south" ], "name": "updated-arbitrary-secret-name-example" } }, "ImportedCertificateVersion": { "description": "Example imported certificate version", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "intermediate": "-----BEGIN CERTIFICATE-----\nMIIE3DCCBGKgAwIBAgIUKncnp6BdSUKAFGBcP4YVp/gTb7gwCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END RSA PRIVATE KEY-----", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_type": "imported_cert", "secret_name": "example-imported-certificate", "serial_number": "38:eb:01:a3:22:e9:de:55:24:56:9b:14:cb:e2:f3:e3:e2:fb:f5:18", "validity": { "not_before": "2020-10-05T21:33:11Z", "not_after": "2030-10-05T11:49:42Z" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ImportedCertificateManagedCsrVersion": { "description": "Example imported certificate version.", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICsTCCAZkCAQAwDzENMAsGA1UEAxMEdGVzdDCCASIwDQYJKoZIhvcNAQEBBQAD\n-----END CERTIFICATE REQUEST-----", "intermediate": "-----BEGIN CERTIFICATE-----\nMIIE3DCCBGKgAwIBAgIUKncnp6BdSUKAFGBcP4YVp/gTb7gwCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END RSA PRIVATE KEY-----", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_type": "imported_cert", "secret_name": "example-imported-certificate-managed-csr", "serial_number": "38:eb:01:a3:22:e9:de:55:24:56:9b:14:cb:e2:f3:e3:e2:fb:f5:18", "validity": { "not_before": "2020-10-05T21:33:11Z", "not_after": "2030-10-05T11:49:42Z" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "KVSecretVersion": { "description": "Example of a KV secret version.", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "data": { "key1": "val1" }, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_type": "kv", "secret_name": "example-kv-secret", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ArbitrarySecretVersion": { "description": "Example of an arbitrary secret version.", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "payload": "secret-data", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-arbitrary-secret", "secret_type": "arbitrary", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "IAMCredentialsSecretVersion": { "description": "Example IAM Credentials secret version", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "api_key": "RmnPBn6n1dzoo0v3kyznKEpg0WzdTpW9lW7FtKa017_u", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9aaa", "secret_name": "example-iam-credentials-secret", "secret_type": "iam_credentials", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "PublicCertificateVersion": { "description": "Example public certificate version", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "expiration_date": "2030-10-05T11:49:42Z", "id": "f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "payload_available": true, "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "intermediate": "-----BEGIN CERTIFICATE-----\nMIIE3DCCBGKgAwIBAgIUKncnp6BdSUKAFGBcP4YVp/gTb7gwCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END RSA PRIVATE KEY-----", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_name": "example-public-certificate", "secret_type": "public_cert", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd", "validity": { "not_before": "2020-10-05T21:33:11Z", "not_after": "2030-10-05T11:49:42Z" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "UsernamePasswordSecretVersion": { "description": "Example username password secret version", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "username": "admin", "password": "admin1234", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-username-password-secret", "secret_type": "username_password", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "CustomCredentialsSecretVersion": { "description": "Example custom credentials secret version", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "credentials_content": { "token": "xF9v7OztItL5DOnFgHfS9NCT1sLTUew8KYZcZfxI" }, "credentials_id": "3a7c97a0-qee3-4272-9f83-bceddce8x69a", "expiration_date": "2023-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e714", "payload_available": true, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "77d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-custom-credentials-secret", "secret_type": "custom_credentials", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ServiceCredentialsSecretVersion": { "description": "A sample service credentials secret version.", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "credentials": { "apikey": "2epu_ykv0PMp2MhxQmDMn7VzrkSlBwi6BOI8uthi_RCS", "cos_hmac_keys": { "access_key_id": "af56af3af56a4c738afea662c47840b3", "secret_access_key": "bc69b010402011eebe560242ac120002aedc950c7ea6ac4d" }, "endpoints": "https://control.cloud-object-storage.cloud.ibm.com/v2/endpoints", "iam_apikey_description": "Auto-generated for key 6d1f818f-0ceb-4353-ac36-b1d6421c5898", "iam_apikey_id": "ApiKey-6d1f818f-0ceb-4353-ac36-b1d6421c5898", "iam_apikey_name": "6d1f818f-0ceb-4353-ac36-b1d6421c5898", "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/22018f3c34ff4ff193698d15ca316946::serviceid:ServiceId-6183f10e-6db1-44e8-806c-cfb711b87feb", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/22018f3c34ff4ff193698d15ca316946:871d0a4d-feb1-4cb0-8dc1-77c78cee8aab::" }, "expiration_date": "2023-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "resource_key": { "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/22018f3c34ff4ff193698d15ca316946:871d0a4d-feb1-4cb0-8dc1-77c78cee8aab:resource-key:af56af3a-f56a-4c73-8afe-a662c47840b3", "name": "secret_name_versionid" }, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-service-credentials-secret", "secret_type": "service_credentials", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ServiceCredentialsSecretVersionMetadata": { "description": "A sample of the metadata for a service credentials secret version.", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "expiration_date": "2023-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "resource_key": { "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/22018f3c34ff4ff193698d15ca316946:871d0a4d-feb1-4cb0-8dc1-77c78cee8aab:resource-key:af56af3a-f56a-4c73-8afe-a662c47840b3", "name": "secret_name_versionid" }, "resource_key_name": "secret_name_versionid", "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-service-credentials-secret", "secret_type": "service_credentials", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ImportedCertificateVersionMetadata": { "description": "Example imported certificate version metadata", "value": { "alias": "current", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-imported-certificate", "secret_type": "imported_cert", "serial_number": "38:eb:01:a3:22:e9:de:55:24:56:9b:14:cb:e2:f3:e3:e2:fb:f5:18", "validity": { "not_after": "2030-10-05T11:49:42Z", "not_before": "2022-06-27T11:58:15Z" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "KVSecretVersionMetadata": { "description": "Example KV secret version metadata", "value": { "alias": "current", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-kv-secret", "secret_type": "kv", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "IAMCredentialsSecretVersionMetadata": { "description": "Example IAM Credentials secret version metadata", "value": { "alias": "current", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9aaa", "secret_name": "example-iam-credentials-secret", "secret_type": "iam_credentials", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ArbitrarySecretVersionMetadata": { "description": "Example arbitrary version metadata", "value": { "alias": "current", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-arbitrary-secret", "secret_type": "arbitrary", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "UsernamePasswordSecretVersionMetadata": { "description": "Example user credentials version metadata", "value": { "alias": "current", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "rotation": { "auto_rotate": true, "interval": 30, "unit": "day" }, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-arbitrary", "secret_type": "username_password", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "CustomCredentialsSecretVersionMetadata": { "description": "Example custom credentials version metadata", "value": { "alias": "current", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "credentials_id": "3a7c97a0-qee3-4272-9f83-bceddce8x69a", "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-arbitrary", "secret_type": "custom_credentials", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "PublicCertificateVersionMetadata": { "description": "Example public certificate version metadata", "value": { "alias": "current", "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "expiration_date": "2030-10-05T11:49:42Z", "id": "f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "payload_available": true, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_name": "example-public-certificate", "secret_type": "public_cert", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd", "validity": { "not_after": "2030-10-05T11:49:42Z", "not_before": "2020-10-05T21:33:11Z" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "SecretMetadataPaginatedCollection": { "description": "Example secret metadata collection response", "value": { "first": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?limit=50" }, "previous": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?offset=50&limit=50" }, "last": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?offset=200&limit=50" }, "limit": 50, "next": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?offset=150&limit=50" }, "offset": 100, "secrets": [ { "alt_names": [ "s1.example.com", "*.s2.example.com" ], "common_name": "example.com", "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:a931192f-b6a9-43d6-a59a-834f3003af7b", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description for this secret.", "downloaded": false, "expiration_date": "2030-10-05T11:49:42Z", "id": "a931192f-b6a9-43d6-a59a-834f3003af7b", "intermediate_included": true, "issuer": "DigiCert", "key_algorithm": "RSA2048", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "my-imported-certificate", "private_key_included": true, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd", "secret_type": "imported_cert", "signing_algorithm": "SHA256-RSA", "state": 1, "state_description": "active", "updated_at": "2022-10-05T21:33:11Z", "validity": { "not_before": "2020-10-05T21:33:11Z", "not_after": "2030-10-05T11:49:42Z" }, "versions_total": 1 }, { "alt_names": [ "s1.example.com", "*.s2.example.com" ], "common_name": "example.com", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "created_at": "2020-10-05T21:33:11Z", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:cb7a2502-8ede-47d6-b5b6-1b7af6b6f563", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description for this secret.", "downloaded": false, "expiration_date": "2030-10-05T11:49:42Z", "id": "f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "issuer": "Lets Encrypt", "issuance_info": { "auto_rotated": false, "ordered_on": "2022-10-06T06:15:55Z", "state": 1, "state_description": "active" }, "bundle_certs": true, "ca": "lets-encrypt-config", "dns": "cloud-internet-services-config", "key_algorithm": "RSA2048", "labels": [ "dev", "us-south" ], "updated_at": "2022-10-05T21:33:11Z", "locks_total": 0, "name": "my-public-certificate", "rotation": { "auto_rotate": true, "rotate_keys": true }, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd", "secret_type": "public_cert", "signing_algorithm": "SHA256-RSA", "state": 1, "state_description": "active", "validity": { "not_before": "2020-10-05T21:33:11Z", "not_after": "2030-10-05T11:49:42Z" }, "versions_total": 1 } ], "total_count": 232 } }, "SecretVersionMetadataCollection": { "description": "Example secret version metadata collection response", "value": { "versions": [ { "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "expiration_date": "2030-10-05T11:49:42Z", "id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "payload_available": true, "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a", "secret_name": "example-imported-certificate", "secret_type": "imported_cert", "serial_number": "38:eb:01:a3:22:e9:de:55:24:56:9b:14:cb:e2:f3:e3:e2:fb:f5:18", "validity": { "not_after": "2030-10-05T11:49:42Z", "not_before": "2022-06-27T11:58:15Z" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } ], "total_count": 1 } }, "PublicCertificateActionValidateManualDNSPrototype": { "description": "The request body of the action to validate DNS challenges for public certificates.", "value": { "action_type": "public_cert_action_validate_dns_challenge" } }, "PublicCertificateActionValidateManualDNS": { "description": "The response body of the action to validate manual DNS challenges for public certificates.", "value": { "action_type": "public_cert_action_validate_dns_challenge" } }, "PrivateCertificateActionRevokePrototype": { "description": "The request body of the action to revoke private certificates.", "value": { "action_type": "private_cert_action_revoke_certificate" } }, "PrivateCertificateActionRevoke": { "description": "The request body of the action to revoke private certificates.", "value": { "action_type": "private_cert_action_revoke_certificate", "revocation_time_seconds": 1667982994 } }, "PrivateCertificateVersionActionRevokePrototype": { "description": "The request body of the action to revoke private certificate versions.", "value": { "action_type": "private_cert_action_revoke_certificate" } }, "PrivateCertificateVersionActionRevoke": { "description": "The request body of the action to revoke private certificate versions.", "value": { "action_type": "private_cert_action_revoke_certificate", "revocation_time_seconds": 1667982994 } }, "PrivateCertificateConfigurationActionRevokePrototype": { "summary": "Revoke an Intermediate CA certificate", "description": "The request body of the action to revoke a private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_revoke_ca_certificate" } }, "PrivateCertificateConfigurationActionRotatePrototype": { "summary": "Rotate an Intermediate CA certificate", "description": "The request body of the action to rotate an intermediate CA certificate.", "value": { "action_type": "private_cert_configuration_action_rotate_intermediate" } }, "PrivateCertificateConfigurationActionRevoke": { "description": "The request body of the action to revoke a private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_revoke_ca_certificate", "revocation_time_seconds": 1667982994 } }, "PrivateCertificateConfigurationActionSignCSRPrototype": { "summary": "Sign a certificate signing request (CSR)", "description": "The request body of the action to sign the CSR of the private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_sign_csr", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICiDCCAXACAQAwGDEWMBQGA1UEAxMNct5ANo8jybxCwNjHOA==\n-----END CERTIFICATE REQUEST-----", "common_name": "example.com", "alt_names": [ "alt-name-1", "alt-name-2" ], "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com" ], "ttl": "2190h", "format": "pem", "max_path_length": -1, "exclude_cn_from_sans": false, "use_csr_values": false } }, "PrivateCertificateConfigurationActionSignCSR": { "summary": "Sign a certificate signing request (CSR)", "description": "The response body of the action to sign the CSR of the private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_sign_csr", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICiDCCAXACAQAwGDEWMBQGA1UEAxMNct5ANo8jybxCwNjHOA==\n-----END CERTIFICATE REQUEST-----", "common_name": "example.com", "alt_names": [ "alt-name-1", "alt-name-2" ], "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com" ], "ttl": "2190h", "data": { "certificate": "-----BEGIN CERTIFICATE-----\nMIIGRjCCBS6gAwIBAgIUSKW6zI+E9JU4bva\n-----END CERTIFICATE-----", "expiration": 1825612535, "issuing_ca": "-----BEGIN CERTIFICATE-----\nMIIGRjCCBS6gAwIBAgIUSKW6zI+E9JU4bvad\n-----END CERTIFICATE-----" }, "format": "pem", "max_path_length": -1, "use_csr_values": false } }, "PrivateCertificateConfigurationActionRotate": { "summary": "Rotate a private certificate configuration.", "description": "The response body of the action to rotate a private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_rotate_intermediate", "name": "intermediateCA", "type": "intermediate_certificate_authority", "config": { "alt_names": [ "alt-name-1", "alt-name-2" ], "common_name": "example.com", "country": [], "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICiDCCAXACAQAwGDEWMBQGA1UEAxMNct5ANo8jybxCwNjHOA==\n-----END CERTIFICATE REQUEST-----", "data": { "ca_chain": [ "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----" ], "certificate": "-----BEGIN CERTIFICATE-----\nMIIGRjCCBS6gAwIBAgIUSKW6zI+E9JU4bva\n-----END CERTIFICATE-----", "expiration": 1825612535, "issuing_ca": "-----BEGIN CERTIFICATE-----\nMIIGRjCCBS6gAwIBAgIUSKW6zI+E9JU4bvad\n-----END CERTIFICATE-----", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd" }, "format": "pem", "intermediate_certificate_authority": "intermediateCA", "ip_sans": "127.0.0.1", "locality": [], "max_path_length": -1, "organization": [], "other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com" ], "ou": [], "permitted_dns_domains": [], "postal_code": [], "province": [], "street_address": [], "ttl": 3600, "uri_sans": "https://www.example.com/test", "use_csr_values": false } } }, "PrivateCertificateConfigurationActionSignIntermediatePrototype": { "summary": "Sign an intermediate certificate authority", "description": "The request body of the action to sign the intermediate certificate authority for the private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_sign_intermediate", "common_name": "example.com", "intermediate_certificate_authority": "example-intermediate-CA" } }, "PrivateCertificateConfigurationActionSignIntermediate": { "summary": "Sign an intermediate certificate CA response", "description": "The response body of the action to sign the intermediate certificate authority for the private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_sign_intermediate", "common_name": "example.com", "intermediate_certificate_authority": "example-intermediate-CA" } }, "PrivateCertificateConfigurationActionSetSignedPrototype": { "summary": "Set signed an intermediate certificate CA", "description": "The request body of the action to sign the set for the private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_set_signed", "certificate": "-----BEGIN CERTIFICATE-----\nMIIGRjCCBS6gAwIBAgIUSKW6zI+E9JU4bva\n-----END CERTIFICATE-----" } }, "PrivateCertificateConfigurationActionSetSigned": { "summary": "Set signed intermediate certificate CA response", "description": "The response body of the action to sign the set for the private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_set_signed", "certificate": "-----BEGIN CERTIFICATE-----\nMIIGRjCCBS6gAwIBAgIUSKW6zI+E9JU4bva\n-----END CERTIFICATE-----" } }, "PrivateCertificateConfigurationActionRotateCRLPrototype": { "summary": "Rotate CRL of an intermediate certificate CA", "description": "The request body of the action to rotate the CRL of the private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_rotate_crl" } }, "PrivateCertificateConfigurationActionRotateCRL": { "summary": "Rotate CRL of an intermediate certificate CA response", "description": "The response body of the action to rotate the CRL of the private certificate configuration.", "value": { "action_type": "private_cert_configuration_action_rotate_crl", "success": true } }, "ImportedCertificateVersionPrototype": { "description": "The request body to rotate imported certificates.", "value": { "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIwx\n-----END CERTIFICATE-----", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "intermediate": "-----BEGIN CERTIFICATE-----\nMIIE3DCCBGKgAwIBAgIUKncnp6BdSUKAFGBcP4YVp/gTb7gwCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END RSA PRIVATE KEY-----", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ImportedCertificateManagedCsrVersionPrototype": { "description": "The request body to rotate imported certificates.", "value": { "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIwx\n-----END CERTIFICATE-----", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "intermediate": "-----BEGIN CERTIFICATE-----\nMIIE3DCCBGKgAwIBAgIUKncnp6BdSUKAFGBcP4YVp/gTb7gwCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "UsernamePasswordSecretVersionPrototype": { "description": "The request body to rotate user credentials.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "password": "password", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ServiceCredentialsSecretVersionPrototype": { "description": "The request body that is used to rotate service credentials.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "KVSecretVersionPrototype": { "description": "The request body to rotate KV secrets.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "data": { "key1": "val1" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "ArbitrarySecretVersionPrototype": { "description": "The request body to rotate arbitrary secrets.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "payload": "updated secret credentials", "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "CustomCredentialsSecretVersionPrototype": { "description": "The request body to rotate Custom credentials secrets.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "IAMCredentialsSecretVersionPrototype": { "description": "The request body of the new version of the IAM credentials secret.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "IAMCredentialsSecretRestoreFromVersionPrototype": { "description": "The request body of the updated version of the IAM credentials secret.", "value": { "restore_from_version": "previous", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "PublicCertificateVersionPrototype": { "description": "The request body to rotate public certificates.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "rotation": { "rotate_keys": true }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "PrivateCertificateVersionPrototype": { "description": "The request body to rotate private certificates.", "value": { "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" }, "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICiDCCAXACAQAwGDEWMBQGA1UEAxMNct5ANo8jybxCwNjHOA==\n-----END CERTIFICATE REQUEST-----" } }, "PrivateCertificateVersion": { "description": "Example of the private certificate version", "value": { "alias": "current", "auto_rotated": true, "created_at": "2022-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:24ec2c34-38ee-4038-9f1d-9a629423158d", "downloaded": false, "expiration_date": "2030-01-01T00:00:00Z", "id": "24ec2c34-38ee-4038-9f1d-9a629423158d", "payload_available": true, "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "issuing_ca": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "ca_chain": [ "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----" ], "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END RSA PRIVATE KEY-----", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_id": "7bf3814d-58f8-4df8-9cbd-f6860e4ca973", "secret_name": "example-private-certificate", "secret_type": "private_cert", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd", "validity": { "not_after": "2030-01-01T00:00:00Z", "not_before": "2022-10-05T21:33:11Z" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "PrivateCertificateVersionMetadata": { "description": "Example of private certificate version metadata", "value": { "alias": "current", "auto_rotated": false, "created_at": "2020-10-05T21:33:11Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "downloaded": false, "expiration_date": "2030-10-05T11:49:42Z", "id": "f075f0b3-71e4-4a14-b60f-0b38b855a3d1", "payload_available": true, "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "secret_name": "example-private-certificate", "secret_type": "private_cert", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd", "validity": { "not_after": "2030-10-05T11:49:42Z", "not_before": "2030-09-05T21:33:11Z" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "PrivateCertificateMetadataPatch": { "description": "Example of the input to update private certificate metadata", "value": { "description": "updated private certificate description", "labels": [ "dev", "us-south" ], "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "name": "updated-private-certificate-name", "rotation": { "auto_rotate": true, "interval": 30, "unit": "day" } } }, "PrivateCertificate": { "description": "Example private certificate", "value": { "alt_names": [ "s1.example.com", "*.s2.example.com" ], "certificate_authority": "example-intermediate-CA", "certificate_template": "example-certificate-template", "common_name": "example.com", "created_at": "2022-10-02T14:08:07Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:cb7a2502-8ede-47d6-b5b6-1b7af6b6f563", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description for this secret.", "downloaded": true, "retrieved_at": "2025-07-27T12:34:15Z", "expiration_date": "2030-03-02T15:08:37Z", "id": "cb7a2502-8ede-47d6-b5b6-1b7af6b6f563", "issuer": "example.com", "key_algorithm": "RSA2048", "labels": [ "dev", "us-south" ], "locks_total": 0, "name": "example-private-certificate", "next_rotation_date": "2022-03-02T14:08:07Z", "rotation": { "auto_rotate": true, "interval": 1, "unit": "month" }, "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "issuing_ca": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----", "ca_chain": [ "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----" ], "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END RSA PRIVATE KEY-----", "secret_group_id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "secret_type": "private_cert", "serial_number": "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd", "signing_algorithm": "SHA256-RSA", "state": 1, "state_description": "active", "updated_at": "2022-03-02T14:08:37Z", "validity": { "not_before": "2022-03-02T15:08:37Z", "not_after": "2030-03-01T00:00:00Z" }, "versions_total": 1 } }, "PrivateCertificateMetadata": { "description": "Example of private certificate metadata", "value": { "alt_names": [ "s1.example.com", "*.s2.example.com" ], "certificate_authority": "example-intermediate-CA", "certificate_template": "example-certificate-template", "common_name": "example.com", "created_at": "2022-03-02T14:08:07Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crn": "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:cb7a2502-8ede-47d6-b5b6-1b7af6b6f563", "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "description": "Extended description for this secret.", "downloaded": true, "retrieved_at": "2025-07-27T12:34:15Z", "expiration_date": "2022-03-02T15:08:37Z", "id": "cb7a2502-8ede-47d6-b5b6-1b7af6b6f563", "issuer": "example.com", "key_algorithm": "RSA2048", "labels": [ "dev", "us-south" ], "locks_total": 1, "name": "example-private-certificate", "next_rotation_date": "2022-03-02T14:08:07Z", "rotation": { "auto_rotate": true, "interval": 1, "unit": "month" }, "secret_group_id": "bc656587-8fda-4d05-9ad8-b1de1ec7e712", "secret_type": "private_cert", "serial_number": "d9:be:fe:35:ba:09:42:b5", "signing_algorithm": "SHA256-RSA", "state": 1, "state_description": "active", "updated_at": "2022-03-02T14:08:37Z", "validity": { "not_after": "2022-03-01T00:00:00Z", "not_before": "2022-03-02T15:08:37Z" }, "versions_total": 1 } }, "PrivateCertificatePrototype": { "description": "Example of private certificate request body", "value": { "name": "example-private-certificate", "description": "Description of my private certificates", "secret_type": "private_cert", "secret_group_id": "bfc0a4a9-3d58-4fda-945b-76756af516aa", "labels": [ "dev", "us-south" ], "certificate_template": "example-certificate-template", "common_name": "localhost", "alt_names": [ "alt-name-1", "alt-name-2" ], "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "ttl": "90d", "rotation": { "auto_rotate": true, "interval": 60, "unit": "day" }, "custom_metadata": { "metadata_custom_key": "metadata_custom_value" }, "version_custom_metadata": { "custom_version_key": "custom_version_value" } } }, "SecretLockCollectionPrototype": { "description": "Example of request body to create secret locks", "value": { "locks": [ { "name": "lock-example-1", "description": "lock for consumer 1", "attributes": { "key": "value" } }, { "name": "lock-example-2", "description": "lock for consumer 2", "attributes": { "key": "value" } } ] } }, "SecretLocks": { "description": "Example of response body to create secret locks", "value": { "secret_id": "0cf4addb-7a90-410b-a3a7-a15bbe2b7909", "secret_group_id": "d8371728-95c8-4c12-b2af-1af98adb9e41", "secret_type": "arbitrary", "versions": [ { "version_id": "7bf3814d-58f8-4df8-9cbd-f6860e4ca973", "version_alias": "current", "locks": [ "lock-3", "lock-4" ], "payload_available": true }, { "version_id": "5bf89b0c-df55-c8d5-7ad6-8816951c6784", "version_alias": "previous", "locks": [ "lock-example-1", "lock-example-2" ], "payload_available": true } ] } }, "SecretLocksPaginatedCollection": { "description": "Example of response body for listing secret locks", "value": { "first": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?limit=50" }, "previous": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?offset=50&limit=50" }, "limit": 50, "last": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?offset=200&limit=50" }, "locks": [ { "attributes": { "key": "value" }, "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "description": "Lock for consumer 1.", "name": "lock-example-1", "secret_group_id": "d8371728-95c8-4c12-b2af-1af98adb9e41", "secret_id": "0cf4addb-7a90-410b-a3a7-a15bbe2b7909", "secret_version_id": "7bf3814d-58f8-4df8-9cbd-f6860e4ca973", "secret_version_alias": "current", "updated_at": "2022-10-05T21:33:11Z" }, { "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "description": "Lock for consumer 2.", "name": "lock-example-2", "secret_group_id": "d8371728-95c8-4c12-b2af-1af98adb9e41", "secret_id": "0cf4addb-7a90-410b-a3a7-a15bbe2b7909", "secret_version_id": "7bf3814d-58f8-4df8-9cbd-f6860e4ca973", "secret_version_alias": "current", "updated_at": "2022-10-05T21:33:11Z" } ], "next": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?offset=150&limit=50" }, "offset": 100, "total_count": 2 } }, "SecretsLocksPaginatedCollection": { "description": "Example response for listing all Secrets and locks", "value": { "secrets_locks": [ { "secret_group_id": "d8371728-95c8-4c12-b2af-1af98adb9e41", "secret_id": "0cf4addb-7a90-410b-a3a7-a15bbe2b7909", "secret_type": "imported_cert", "secret_name": "example-imported-certificate", "versions": [ { "version_id": "7bf3814d-58f8-4df8-9cbd-f6860e4ca973", "version_alias": "current", "locks": [ "lock-example-1", "lock-example-2" ] } ] } ], "first": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?limit=50" }, "previous": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?offset=50&limit=50" }, "last": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?offset=200&limit=50" }, "limit": 50, "next": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?offset=150&limit=50" }, "offset": 100, "total_count": 1 } }, "SecretVersionLocksPaginatedCollection": { "description": "Example response for listing secret version locks", "value": { "first": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?limit=50" }, "previous": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?offset=50&limit=50" }, "last": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?offset=200&limit=50" }, "limit": 50, "locks": [ { "attributes": { "key": "value" }, "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "description": "lock for consumer 1.", "name": "lock-example-1", "secret_group_id": "d8371728-95c8-4c12-b2af-1af98adb9e41", "secret_id": "0cf4addb-7a90-410b-a3a7-a15bbe2b7909", "secret_version_alias": "current", "secret_version_id": "7bf3814d-58f8-4df8-9cbd-f6860e4ca973", "updated_at": "2022-10-05T21:33:11Z" } ], "next": { "href": "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?offset=150&limit=50" }, "offset": 100, "total_count": 1 } }, "ConfigurationMetadataCollection": { "description": "Example response for configuring metadata collection", "value": { "first": { "href": "https://something.com" }, "next": { "href": "https://something.com" }, "previous": { "href": "https://something.com" }, "last": { "href": "https://something.com" }, "limit": 25, "offset": 0, "configurations": [ { "config_type": "public_cert_configuration_ca_lets_encrypt", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "lets_encrypt_environment": "production", "name": "lets-encrypt-config", "secret_type": "public_cert", "updated_at": "2022-10-05T21:33:11Z" }, { "config_type": "public_cert_configuration_dns_cloud_internet_services", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "name": "cloud-internet-services-config", "secret_type": "public_cert", "updated_at": "2022-10-05T21:33:11Z" }, { "config_type": "public_cert_configuration_dns_classic_infrastructure", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "name": "classic-infrastructure-config", "secret_type": "public_cert", "updated_at": "2022-10-05T21:33:11Z" }, { "common_name": "ibm.com", "config_type": "private_cert_configuration_root_ca", "created_at": "2022-11-08T11:22:19Z", "created_by": "iam-ServiceId-1ba95813-1b0f-45c1-b46c-969a5fda08d1", "expiration_date": "2030-03-31T01:13:07Z", "key_bits": 2048, "key_type": "rsa", "name": "internal-root", "secret_type": "private_cert", "status": "configured", "updated_at": "2022-11-08T11:22:19Z" }, { "common_name": "ibm.com", "config_type": "private_cert_configuration_intermediate_ca", "created_at": "2022-11-08T11:22:19Z", "created_by": "iam-ServiceId-1ba95813-1b0f-45c1-b46c-969a5fda08d1", "expiration_date": "2030-03-31T01:13:07Z", "issuer": "internal-root", "name": "example-intermediate-CA", "key_bits": 2048, "key_type": "rsa", "secret_type": "private_cert", "status": "configured", "updated_at": "2022-11-08T11:22:19Z" }, { "certificate_authority": "inter-1", "config_type": "private_cert_configuration_template", "created_at": "2022-11-08T11:22:23Z", "created_by": "iam-ServiceId-8e54a866-476b-46cd-ba05-dbeae5f1d984", "name": "example-certificate-template", "secret_type": "private_cert", "updated_at": "2022-11-08T11:22:23Z" }, { "api_key_ref": "a2f9c2e4-a3a8-c508-2bed-fcb7c26843ca", "code_engine": { "job_name": "code-engine-job-name", "project_id": "12345678-5120-4a18-832a-4ba122496633", "region": "us-south" }, "code_engine_key_ref": "sm-access-24bc230d-9855-4825-99b5-ac78be81959c", "config_type": "custom_credentials_configuration", "created_at": "2025-03-23T08:35:29.27Z", "created_by": "IBMid-000002CM7E", "name": "my_config", "schema": { "credentials": [ { "format": "type:string", "name": "token" } ], "parameters": [ { "env_variable_name": "SM_USER_NAME_VALUE", "format": "type:string", "name": "user_name" }, { "env_variable_name": "SM_SCOPE_VALUE", "format": "type:enum[admin|user]", "name": "scope" }, { "env_variable_name": "SM_EXPIRES_VALUE", "format": "type:integer", "name": "expires" } ] }, "secret_type": "custom_credentials", "task_timeout": "10m", "updated_at": "2025-03-23T08:35:29.27Z" } ], "total_count": 7 } }, "PublicCertificateConfigurationCALetsEncryptPrototype": { "description": "The configuration body of the Let's Encrypt CA request for public certificates.", "value": { "config_type": "public_cert_configuration_ca_lets_encrypt", "lets_encrypt_environment": "production", "lets_encrypt_private_key": "-----BEGIN PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END PRIVATE KEY-----", "name": "example-lets-encrypt-config" } }, "PublicCertificateConfigurationDNSCloudInternetServicesPrototype": { "description": "The configuration body of the Cloud Internet Services DNS request for public certificates.", "value": { "cloud_internet_services_apikey": "5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ", "cloud_internet_services_crn": "crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::", "config_type": "public_cert_configuration_dns_cloud_internet_services", "name": "example-cloud-internet-services-config" } }, "PublicCertificateConfigurationCALetsEncrypt": { "description": "Example of the Let's Encrypt CA configuration for public certificates.", "value": { "config_type": "public_cert_configuration_ca_lets_encrypt", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "lets_encrypt_environment": "production", "lets_encrypt_private_key": "-----BEGIN PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END PRIVATE KEY-----", "name": "lets-encrypt-config", "secret_type": "public_cert", "updated_at": "2022-10-05T21:33:11Z" } }, "PublicCertificateConfigurationDNSClassicInfrastructurePrototype": { "description": "The configuration body of the IBM Cloud classic infrastructure (SoftLayer) DNS request for public certificates.", "value": { "classic_infrastructure_password": "sRBm1jkHOH2kn9oBnK5R0ODsRBm1jkHOH2kn9oBnK5R0ODsRBm1jkHOH2kn9oBnK5R0OD", "classic_infrastructure_username": "1234567_JohnDoe@mail.com", "config_type": "public_cert_configuration_dns_classic_infrastructure", "name": "classic-infrastructure-config" } }, "IAMCredentialsConfigurationPrototype": { "description": "The configuration request body for the IBM Cloud IAM credentials engine.", "value": { "api_key": "2epu_ykv0PMp2MhxQmDMn7VzrkSlBwi6BOI8uthi_RCS", "config_type": "iam_credentials_configuration", "name": "iam-configuration" } }, "CustomCredentialsConfigurationPrototype": { "description": "The configuration request body for the Custom credentials engine.", "value": { "name": "my_config", "config_type": "custom_credentials_configuration", "api_key_ref": "a2f9c2e4-a3a8-c508-2bed-fcb7c26843ca", "code_engine": { "job_name": "code-engine-job-name", "project_id": "12345678-5120-4a18-832a-4ba122496633", "region": "us-south" }, "task_timeout": "10m" } }, "PublicCertificateConfigurationDNSCloudInternetServices": { "description": "Example Cloud Internet Services DNS configuration for public certificates", "value": { "cloud_internet_services_apikey": "5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ", "cloud_internet_services_crn": "crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::", "config_type": "public_cert_configuration_dns_cloud_internet_services", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "name": "example-cloud-internet-services-config", "secret_type": "public_cert", "updated_at": "2022-10-05T21:33:11Z" } }, "PublicCertificateConfigurationDNSClassicInfrastructure": { "description": "Example of IBM Cloud classic infrastructure (SoftLayer) DNS configuration for public certificates", "value": { "classic_infrastructure_password": "sRBm1jkHOH2kn9oBnK5R0ODsRBm1jkHOH2kn9oBnK5R0ODsRBm1jkHOH2kn9oBnK5R0OD", "classic_infrastructure_username": "1234567_JohnDoe@mail.com", "config_type": "public_cert_configuration_dns_classic_infrastructure", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "name": "classic-infrastructure-config", "secret_type": "public_cert", "updated_at": "2022-10-05T21:33:11Z" } }, "IAMCredentialsConfiguration": { "description": "Example of the configuration of the IBM Cloud IAM credentials engine", "value": { "api_key": "2epu_ykv0PMp2MhxQmDMn7VzrkSlBwi6BOI8uthi_RCS", "disabled": false, "config_type": "iam_credentials_configuration", "created_at": "2022-06-27T11:58:15Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "name": "iam-configuration", "secret_type": "iam_credentials", "updated_at": "2022-10-05T21:33:11Z" } }, "CustomCredentialsConfiguration": { "description": "Example of the configuration of the Custom credentials engine", "value": { "config_type": "custom_credentials_configuration", "created_at": "2025-03-23T08:35:29.27Z", "created_by": "IBMid-000002CM7E", "name": "my_config", "secret_type": "custom_credentials", "updated_at": "2025-03-23T08:35:29.27Z", "api_key_ref": "a2f9c2e4-a3a8-c508-2bed-fcb7c26843ca", "code_engine_key_ref": "sm-access-24bc230d-9855-4825-99b5-ac78be81959c", "task_timeout": "10m", "code_engine": { "job_name": "code-engine-job-name", "project_id": "12345678-5120-4a18-832a-4ba122496633", "region": "us-south" }, "schema": { "credentials": [ { "format": "type:string, required:true", "name": "token" } ], "parameters": [ { "env_variable_name": "SM_USER_NAME_VALUE", "format": "type:string", "name": "user_name" }, { "env_variable_name": "SM_SCOPE_VALUE", "format": "type:enum[admin|user]", "name": "scope" }, { "env_variable_name": "SM_EXPIRES_VALUE", "format": "type:integer", "name": "expires" } ] } } }, "PublicCertificateConfigurationCALetsEncryptPatch": { "description": "Example of the Let's Encrypt CA configuration update for public certificates", "value": { "lets_encrypt_environment": "production", "lets_encrypt_private_key": "-----BEGIN PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END PRIVATE KEY-----" } }, "PublicCertificateConfigurationDNSCloudInternetServicesPatch": { "description": "Example of the Cloud Internet Services DNS configuration update for public certificates", "value": { "cloud_internet_services_apikey": "5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ", "cloud_internet_services_crn": "crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::" } }, "PublicCertificateConfigurationDNSClassicInfrastructurePatch": { "description": "Example of the IBM Cloud classic infrastructure (SoftLayer) DNS configuration update for public certificates", "value": { "classic_infrastructure_password": "sRBm1jkHOH2kn9oBnK5R0ODsRBm1jkHOH2kn9oBnK5R0ODsRBm1jkHOH2kn9oBnK5R0OD", "classic_infrastructure_username": "1234567_JohnDoe@mail.com" } }, "PrivateCertificateConfigurationRootCAPrototype": { "description": "Example of the private certificate authority and the root certificate authority", "value": { "config_type": "private_cert_configuration_root_ca", "name": "example-root-CA", "max_ttl": "43830h", "crl_expiry": "72h", "crl_disable": false, "crl_distribution_points_encoded": true, "issuing_certificates_urls_encoded": true, "common_name": "example.com", "alt_names": [ "alt-name-1", "alt-name-2" ], "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com" ], "ttl": "2190h", "format": "pem", "private_key_format": "der", "key_type": "rsa", "key_bits": 4096, "max_path_length": -1, "exclude_cn_from_sans": false } }, "PrivateCertificateConfigurationRootCAwithHsmPrototype": { "description": "Example of the private certificate authority and the root certificate authority using HSM key", "value": { "config_type": "private_cert_configuration_root_ca", "name": "example-root-CA", "max_ttl": "43830h", "crl_expiry": "72h", "crl_disable": false, "crl_distribution_points_encoded": true, "issuing_certificates_urls_encoded": true, "common_name": "example.com", "alt_names": [ "alt-name-1", "alt-name-2" ], "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com" ], "ttl": "2190h", "format": "pem", "private_key_format": "der", "key_type": "rsa", "key_bits": 4096, "max_path_length": -1, "exclude_cn_from_sans": false, "crypto_key": { "id": "19f88b9c-4f2f-405c-b877-a09338575c3f", "label": "my_key", "allow_generate_key": true, "provider": { "type": "hyper_protect_crypto_services", "instance_crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/791f3fb10486421e97aa8512f18b7e65:b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5::", "pin_iam_credentials_secret_id": "6ebb80d3-26d1-4e24-81d6-afb0d8e22f54", "private_keystore_id": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5" } } } }, "PrivateCertificateConfigurationIntermediateCAPrototype": { "description": "The request body of the intermediate certificate authority for private certificates.", "value": { "config_type": "private_cert_configuration_intermediate_ca", "name": "example-intermediate-CA", "max_ttl": "26300h", "signing_method": "internal", "issuer": "example-root-CA", "crl_expiry": "72h", "crl_disable": false, "crl_distribution_points_encoded": true, "issuing_certificates_urls_encoded": true, "common_name": "example.com", "alt_names": [ "alt-name-1", "alt-name-2" ], "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com" ], "format": "pem", "private_key_format": "der", "key_type": "rsa", "key_bits": 4096, "exclude_cn_from_sans": false } }, "PrivateCertificateConfigurationIntermediateCAwithHsmPrototype": { "description": "The request body of the intermediate certificate authority using HSM key for private certificates.", "value": { "config_type": "private_cert_configuration_intermediate_ca", "name": "example-intermediate-CA", "max_ttl": "26300h", "signing_method": "internal", "issuer": "example-root-CA", "crl_expiry": "72h", "crl_disable": false, "crl_distribution_points_encoded": true, "issuing_certificates_urls_encoded": true, "common_name": "example.com", "alt_names": [ "alt-name-1", "alt-name-2" ], "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com" ], "format": "pem", "private_key_format": "der", "key_type": "rsa", "key_bits": 4096, "exclude_cn_from_sans": false, "crypto_key": { "id": "19f88b9c-4f2f-405c-b877-a09338575c3f", "label": "my_key", "allow_generate_key": true, "provider": { "type": "hyper_protect_crypto_services", "instance_crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/791f3fb10486421e97aa8512f18b7e65:b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5::", "pin_iam_credentials_secret_id": "6ebb80d3-26d1-4e24-81d6-afb0d8e22f54", "private_keystore_id": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5" } } } }, "PrivateCertificateConfigurationTemplatePrototype": { "description": "The certificate template.", "value": { "config_type": "private_cert_configuration_template", "name": "example-certificate-template", "allow_any_name": true, "allow_bare_domains": true, "allow_glob_domains": true, "allow_ip_sans": true, "allow_localhost": true, "allow_subdomains": false, "allow_wildcard_certificates": true, "allowed_domains": [ "example.com", "acme.com" ], "allowed_domains_template": true, "allowed_other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com", "1.3.6.1.4.1.201.10.5.5;UTF-8:*" ], "allowed_secret_groups": "d898bb90-82f6-4d61-b5cc-b079b66cfa76", "allowed_uri_sans": [ "example.com", "acme://*" ], "certificate_authority": "example-intermediate-CA", "client_flag": true, "code_signing_flag": false, "email_protection_flag": false, "enforce_hostnames": false, "ext_key_usage": [], "ext_key_usage_oids": [], "key_bits": 2048, "key_type": "rsa", "key_usage": [ "DigitalSignature", "KeyAgreement", "KeyEncipherment" ], "max_ttl": "24h", "server_flag": true, "ttl": "8h", "use_csr_common_name": true, "use_csr_sans": true } }, "PrivateCertificateConfigurationRootCA": { "description": "The request body of the root certificate authority for private certificates.", "value": { "alt_names": [ "alt-name-1", "alt-name-2" ], "common_name": "example.com", "config_type": "private_cert_configuration_root_ca", "country": [], "created_at": "2030-03-14T14:51:32.802Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crl_disable": false, "crl_distribution_points_encoded": true, "crl_expiry_seconds": 259200, "data": { "certificate": "-----BEGIN CERTIFICATE-----\\nMIIIsDCCBpigAwIBsQ9YmHmWDP4=\\n-----END CERTIFICATE-----", "expiration": 1686689494, "issuing_ca": "-----BEGIN CERTIFICATE-----\\nMIIIsDCCBpigAwIBAsQ9YmHmWDP4=\\n-----END CERTIFICATE-----" }, "exclude_cn_from_sans": false, "expiration_date": "2030-06-13T20:51:34.000Z", "format": "pem", "ip_sans": "127.0.0.1", "issuing_certificates_urls_encoded": true, "key_bits": 4096, "key_type": "rsa", "locality": [], "max_path_length": -1, "max_ttl_seconds": 157788000, "name": "example-root-CA", "organization": [], "other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com" ], "ou": [], "permitted_dns_domains": [], "postal_code": [], "private_key_format": "der", "province": [], "secret_type": "private_cert", "serial_number": "59:09:26:bd:32:5e:dd:29:1d:7f:36:48:9f:c1:79:9f:05:7a:f3:c1", "status": "configured", "street_address": [], "ttl_seconds": 7884000, "updated_at": "2030-03-14T14:51:32.802Z", "uri_sans": "https://www.example.com/test" } }, "PrivateCertificateConfigurationIntermediateCA": { "description": "The intermediate certificate authority.", "value": { "alt_names": [ "alt-name-1", "alt-name-2" ], "common_name": "example.com", "config_type": "private_cert_configuration_root_ca", "country": [], "created_at": "2030-03-14T14:51:32.802Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "crl_disable": false, "crl_distribution_points_encoded": true, "crl_expiry_seconds": 259200, "serial_number": "4e:b8:52:7a:cd:4f:2c:96:31:37:9b:05:21:74:c6:81:91:7c:96:82", "data": { "ca_chain": [ "-----BEGIN CERTIFICATE-----\nMIIDODCCAiCgAwIBAgIUTrhSes1PLJYxNJYxN5sFIX\ne+aEPpX6nlJMDfZn\n-----END CERTIFICATE-----" ], "certificate": "-----BEGIN CERTIFICATE-----\nMIIDODCCAiCgAwIBAgIUTrhSes1PLJYxN5h\ne+aEPpX6nlJMDfZn\n-----END CERTIFICATE-----", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICiDCCAXACAQAwGDEWMBQGA1UEAxMNct5ANo8jybxCwNjHOA==\n-----END CERTIFICATE REQUEST-----", "expiration": 1982238414 }, "exclude_cn_from_sans": false, "format": "pem", "ip_sans": "127.0.0.1", "issuer": "example-root-CA", "issuing_certificates_urls_encoded": true, "key_bits": 4096, "key_type": "rsa", "locality": [], "max_ttl_seconds": 94680000, "name": "example-intermediate-CA", "organization": [], "other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com" ], "ou": [], "postal_code": [], "private_key_format": "der", "province": [], "secret_type": "private_cert", "signing_method": "internal", "status": "configured", "street_address": [], "updated_at": "2030-03-14T14:57:05.965Z", "uri_sans": "https://www.example.com/test" } }, "PrivateCertificateConfigurationTemplate": { "description": "The certificate template.", "value": { "allow_any_name": true, "allow_bare_domains": true, "allow_glob_domains": true, "allow_ip_sans": true, "allow_localhost": true, "allow_subdomains": false, "allowed_domains": [ "example.com", "acme.com" ], "allowed_domains_template": true, "allowed_other_sans": [ "1.2.3.5.4.3.201.10.4.3;utf8:test@example.com", "1.3.6.1.4.1.201.10.5.5;UTF-8:*" ], "allowed_secret_groups": "d898bb90-82f6-4d61-b5cc-b079b66cfa76", "allowed_uri_sans": [ "example.com", "acme://*" ], "basic_constraints_valid_for_non_ca": false, "certificate_authority": "example-intermediate-CA", "client_flag": true, "code_signing_flag": false, "config_type": "private_cert_configuration_template", "country": [], "created_at": "2030-03-14T15:26:17.257Z", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "email_protection_flag": false, "enforce_hostnames": false, "ext_key_usage": [], "ext_key_usage_oids": [], "key_bits": 2048, "key_type": "rsa", "key_usage": [ "DigitalSignature", "KeyAgreement", "KeyEncipherment" ], "locality": [], "max_ttl_seconds": 86400, "name": "example-certificate-template", "not_before_duration_seconds": 30, "organization": [], "ou": [], "policy_identifiers": [], "postal_code": [], "province": [], "require_cn": true, "secret_type": "private_cert", "server_flag": true, "street_address": [], "ttl_seconds": 28800, "updated_at": "2030-03-14T15:26:17.257Z", "use_csr_common_name": true, "use_csr_sans": true } }, "PrivateCertificateConfigurationRootCAPatch": { "description": "Update a root certificate authority configuration.", "value": { "max_ttl": "26300h", "crl_disable": false, "crl_expiry": "36h", "crl_distribution_points_encoded": false, "issuing_certificates_urls_encoded": false } }, "PrivateCertificateConfigurationIntermediateCAPatch": { "description": "Update an intermediate certificate authority configuration.", "value": { "max_ttl": "26300h", "crl_disable": false, "crl_expiry": "36h", "crl_distribution_points_encoded": false, "issuing_certificates_urls_encoded": false } }, "PrivateCertificateConfigurationTemplatePatch": { "description": "Update a certificate template.", "value": { "allowed_secret_groups": "bc656587-8fda-4d05-9ad8-b1de1ec7e712,ad929698-2adf-5b40-1bc7-3e713b1de1ed", "max_ttl": "8760h" } }, "SecretTask": { "description": "Example of a response with a Secret's Task.", "value": { "id": "sm-task-b49ad24d-81d4-5ebc-b9b9-b0937d1a84d5", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-abeae11c0f21", "creation_date": "2022-04-12T23:20:50.52Z", "last_update_date": "2022-04-12T23:20:50.52Z", "updated_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-abeae11c0f21", "type": "create_credentials", "status": "queued", "trigger": "secret_creation", "secret_id": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5", "secret_version_id": "b49ad24d-81d4-5ebc-b9b9-b0937d1a84d5" } }, "UpdateSecretTaskCredentialsCreated": { "description": "Example of a payload for updating a task with credentials.\nThis will change the `status` of the task from `processing` to `credentials_created`.", "value": { "status": "credentials_created", "credentials": { "id": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5", "payload": { "token": "xF9v7OztItL5DOnFgHfS9NCT1sLTUew8KYZcZfxI" } } } }, "UpdateSecretTaskCredentialsDeleted": { "description": "Example of a payload for updating a task with a successful deletion of credentials.\nThis will change the `status` of the task from `processing` to `credentials_deleted`.", "value": { "status": "credentials_deleted" } }, "UpdateSecretTaskFailed": { "description": "Example of a payload for updating a task with a failure.\nThis will change the `status` of the task from `processing` to `failed`.", "value": { "status": "failed", "errors": [ { "code": "something went wrong", "description": "failed to create credentials" } ] } }, "SecretTaskCollection": { "description": "Example for a list all tasks response.", "value": { "tasks": [ { "id": "sm-task-b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5", "created_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "creation_date": "2022-04-12T23:20:50.52Z", "last_update_date": "2022-04-12T23:21:40.22Z", "updated_by": "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21", "type": "create_credentials", "status": "queued", "trigger": "secret_creation", "secret_id": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5", "secret_version_id": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5" } ] } }, "NotificationsRegistrationPrototype": { "description": "Example Notifications registration configuration request body for Event Notifications.", "value": { "event_notifications_instance_crn": "crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::", "event_notifications_source_description": "Optional description of this source in an Event Notifications instance.", "event_notifications_source_name": "My Secrets Manager" } }, "NotificationsRegistration": { "description": "Example Notifications registration configuration details for Event Notifications.", "value": { "event_notifications_instance_crn": "crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::" } }, "Unauthorized": { "description": "Example of unauthorized error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 401, "errors": [ { "code": "unauthorized", "message": "You provided no credentials or invalid credentials.", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "PaymentRequired": { "description": "Example of payment required error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 402, "errors": [ { "code": "payment_required", "message": "Your Trial plan is now expired.", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "Forbidden": { "description": "Example of forbidden error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 403, "errors": [ { "code": "access_forbidden", "message": "You are not allowed to access this resource.", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "BadRequest": { "description": "Example of bad request error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 400, "errors": [ { "code": "bad_request", "message": "required.name:property \"name\" is missing", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "NotImplemented": { "description": "Example of Not Implemented error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 501, "errors": [ { "code": "not_implemented", "message": "The specified api is not implemented.", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "NotFound": { "description": "Example of `NotFound` error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 404, "errors": [ { "code": "not_found", "message": "A resource with id: 19f88b9c-4f2f-405c-b877-a09338575c3f was not found.", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "Gone": { "description": "Example of `Gone` error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 410, "errors": [ { "code": "gone", "message": "A resource with id: 19f88b9c-4f2f-405c-b877-a09338575c3f no longer exists.", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "InternalServerError": { "description": "Example of internal server error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 500, "errors": [ { "code": "internal_server_error", "message": "Internal server error", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "BadGatewayError": { "description": "Example of bad gateway error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 502, "errors": [ { "code": "bad_gateway", "message": "Bad Gateway", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "ServiceUnavailableError": { "description": "Example of service unavailable error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 503, "errors": [ { "code": "service_unavailable", "message": "Service Unavailable", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "MultipleChoices": { "description": "Example MultipleChoices error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 300, "errors": [ { "code": "multiple_choices", "message": "The request has more than one possible responses", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "Conflict": { "description": "Example Conflict error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 409, "errors": [ { "code": "conflict", "message": "The request conflicts with the current state of the target resource", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } }, "UnprocessableEntity": { "description": "Example UnprocessableEntity error", "value": { "trace": "f9d9d161-e087-4871-963b-88ea3fe72aca", "status_code": 422, "errors": [ { "code": "unprocessable_entity", "message": "The API key is locked. Unlock the API key to complete this operation.", "more_info": "https://cloud.ibm.com/apidocs/secrets-manager" } ] } } }, "links": { "SecretGroupIdForGetSecretGroup": { "description": "The secret group `id` value that is returned in the `create_secret_group` response can be used as\nthe secret group `id` parameter in the `get_secret_group` request.", "operationId": "get_secret_group", "parameters": { "id": "$response.body#/id" } }, "SecretIdForGetSecret": { "description": "The secret `id` value that is returned in the `create_secret` response can be used as\nthe secret `secret_id` parameter in the `get_secret` request.", "operationId": "get_secret", "parameters": { "id": "$response.body#/id" } }, "SecretIdForCreateSecretVersion": { "description": "The secret `id` value that is returned in the `list_secret_versions` response can be used as\nthe secret `secret_id` parameter in the `create_secret_version` request.", "operationId": "create_secret_version", "parameters": { "secret_id": "$response.body#/versions/0/secret_id" } }, "SecretIdForGetSecretVersion": { "description": "The secret `id` value that is returned in the `create_secret` response can be used as\nthe secret `secret_id` parameter in the `get_secret_version` request.", "operationId": "get_secret_version", "parameters": { "secret_id": "$response.body#/id" } }, "SecretNameForGetSecretByName": { "description": "The secret `name` value that is returned in the `update_secret_metadata` response can be used as\nthe secret `name` parameter in the `get_secret_by_name_type` request.", "operationId": "get_secret_by_name_type", "parameters": { "name": "$response.body#/name" } }, "SecretVersionIdForGetSecretVersion": { "description": "The secret version `id` value that is returned in the `list_secret_versions` response can be used as\nthe secret `id` parameter in the `get_secret_version` request.", "operationId": "get_secret_version", "parameters": { "id": "$response.body#/versions/0/id" } }, "SecretVersionIdForGetSecretVersionMetadata": { "description": "The secret version `id` value that is returned in the `list_secret_versions` response can be used as\nthe secret `id` parameter in the `get_secret_version_metadata` request.", "operationId": "get_secret_version_metadata", "parameters": { "id": "$response.body#/versions/0/id" } }, "SecretVersionIdForUpdateSecretVersionMetadata": { "description": "The secret version `id` value that is returned in the `list_secret_versions` response can be used as\nthe secret `id` parameter in the `update_secret_version_metadata` request.", "operationId": "update_secret_version_metadata", "parameters": { "id": "$response.body#/versions/0/id" } }, "SecretIdForListSecretLocks": { "description": "The secret `secret_id` value that is returned in the `create_secret_locks_bulk` response can be used as\nthe secret `secret_id` parameter in the `list_secret_locks` request.", "operationId": "list_secret_locks", "parameters": { "id": "$response.body#/secret_id" } }, "SecretIdForListSecretVersionLocks": { "description": "The secret `secret_id` value that is returned in the `create_secret_locks_bulk` response can be used as\nthe secret `secret_id` parameter in the `list_secret_version_locks` request.", "operationId": "list_secret_version_locks", "parameters": { "secret_id": "$response.body#/secret_id" } }, "SecretVersionIdForListSecretVersionLocks": { "description": "The secret `secret_id` value that is returned in the `create_secret_locks_bulk` response can be used as\nthe secret `id` parameter in the `list_secret_version_locks` request.", "operationId": "list_secret_version_locks", "parameters": { "id": "$response.body#/versions/0/version_id" } }, "SecretIdForCreateSecretVersionLocks": { "description": "The secret `secret_id` value that is returned in the `list_secret_versions` response can be used as\nthe secret `secret_id` parameter in the `create_secret_version_locks` request.", "operationId": "create_secret_version_locks_bulk", "parameters": { "secret_id": "$response.body#/versions/0/secret_id" } }, "SecretVersionIdForCreateSecretVersionLocks": { "description": "The secret `id` value that is returned in the `list_secret_versions` response can be used as\nthe secret `id` parameter in the `create_secret_version_locks_bulk` request.", "operationId": "create_secret_version_locks_bulk", "parameters": { "id": "$response.body#/versions/0/id" } }, "SecretVersionIdForDeleteSecretVersionLocks": { "description": "The secret `id` value that is returned in the `list_secret_versions` response can be used as\nthe secret `id` parameter in the `delete_secret_version_locks_bulk` request.", "operationId": "delete_secret_version_locks_bulk", "parameters": { "id": "$response.body#/versions/0/id" } }, "LockNameForListSecretLocks": { "description": "The lock `name` value that is returned in the `create_secret_locks_bulk` response can be used as\nthe lock `name` parameter in the `get_secret_locks` request.", "operationId": "get_secret_locks", "parameters": { "name": [ "$response.body#/versions/0/locks/0/name" ] } }, "LockNameForDeleteSecretLocks": { "description": "The lock `name` value that is returned in the `get_secret_locks` response can be used as\nthe lock `name` parameter in the `delete_secret_locks_bulk` request.", "operationId": "delete_secret_locks_bulk", "parameters": { "name": [ "$response.body#/secret_locks/0/name" ] } }, "LockNameForListSecretVersionLocks": { "description": "The lock `name` value that is returned in the `create_secret_version_locks_bulk` response can be used as\nthe lock `name` parameter in the `get_secret_version_locks` request.", "operationId": "get_secret_version_locks", "parameters": { "name": [ "$response.body#/versions/0/locks/0/name" ] } }, "LockNameForDeleteSecretVersionLocks": { "description": "The lock `name` value that is returned in the get_secret_version_locks response can be used as\nthe lock `name` parameter in the `delete_secret_version_locks_bulk` request.", "operationId": "delete_secret_version_locks_bulk", "parameters": { "name": [ "$response.body#/secret_locks/0/name" ] } }, "ConfigurationNameForGetConfiguration": { "description": "The configuration `name` value that is returned in the `create_configuration` response can be used as\nthe configuration `name` parameter in the `get_configuration` request.", "operationId": "get_configuration", "parameters": { "name": "$response.body#/name" } } } } }