AKakeyless
Universal Secrets Connector

POST /create-usc

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/create-usc
  • Auth
    none declared

Request body

aws-organization-idstring

The AWS Organization ID to use for a multi-account connector. Requires a target in the AWS Management Account or a delegated administrator account.

azure-kv-namestring

Azure Key Vault name (Relevant only for Azure targets)

delete_protectionstring

Protection from accidental deletion of this object [true/false]

descriptionstring

Description of the Universal Secrets Connector

environment-namesstring

The environments in repo-name/environment-name format, comma-separated (only relevant for: github-scope=repository-environment)

gcp-folder-idstring

GCP Folder ID (Relevant only for GCP targets with folder scope)

gcp-organization-idstring

GCP Organization ID (Relevant only for GCP targets with folder or organization scope)

gcp-project-idstring

GCP Project ID to manage secrets in (Relevant only for GCP targets with project scope). If empty, the project is taken from the target.

gcp-scopestring

The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty.

gcp-sm-regionsstring

GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets.

github-scopestring

The scope where secrets will be created, available options: [repository, organization, repository-environment]

item-custom-fieldsobject

Additional custom fields to associate with the item

jsonboolean

Set output format to JSON

k8s-namespacestring

K8s namespace (Relevant to Kubernetes targets)

namestring required

Universal Secrets Connector name

organization-namestring

The organization name to create the secret in

repository-accessstring
repository-namesstring

The repository names, comma-separated (only relevant for: github-scope=repository)

tagsstring[]

List of the tags attached to this Universal Secrets Connector

target-to-associatestring required

Target Universal Secrets Connector to connect

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

usc-prefixstring

Prefix for all secrets created in AWS Secrets Manager

usc-tagsstring

Comma-separated list of tags to apply to all secrets created on the remote USC

use-prefix-as-filterstring

Whether to filter the USC secret list using the specified usc-prefix [true/false]

use-tags-as-filterboolean

Filter the USC secret list by the value(s) of --usc-tags. [true|false]

Response

CreateUniversalSecretsConnectorResponse wraps response body.

universal_secrets_connector_idinteger
universal_secrets_connector_namestring

Changes

No recorded changes to this operation across all 1 revision of this API.