Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateSecretDetails

The details of the secret that you want to create.

Properties

compartmentId

compartmentId: string

The OCID of the compartment where you want to create the secret.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional description

description: undefined | string

A brief description of the secret. Avoid entering confidential information.

Optional enableAutoGeneration

enableAutoGeneration: undefined | false | true

The value of this flag determines whether or not secret content will be generated automatically. If not set, it defaults to false.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {@code {"Department": "Finance"}}

keyId

keyId: string

The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify.

Optional metadata

metadata: undefined | object

Additional metadata that you can use to provide context about how to use the secret during rotation or other administrative tasks. For example, for a secret that you use to connect to a database, the additional metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.

Optional rotationConfig

rotationConfig: model.RotationConfig

Optional secretContent

secretContent: model.Base64SecretContentDetails

Optional secretGenerationContext

secretName

secretName: string

A user-friendly name for the secret. Secret names should be unique within a vault. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.

Optional secretRules

secretRules: Array<SecretRule>

A list of rules to control how the secret is used and managed.

vaultId

vaultId: string

The OCID of the vault where you want to create the secret.

Functions

getDeserializedJsonObj

getJsonObj