Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Secret

The details of the secret. Secret details do not contain the contents of the secret itself.

Properties

compartmentId

compartmentId: string

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

Optional currentVersionNumber

currentVersionNumber: undefined | number

The version number of the secret version that's currently in use. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

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 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"}}

id

id: string

The OCID of the secret.

Optional isAutoGenerationEnabled

isAutoGenerationEnabled: undefined | false | true

The value of this flag determines whether or not secret content will be generated automatically.

Optional keyId

keyId: undefined | 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 lastRotationTime

lastRotationTime: Date

A property indicating when the secret was last rotated successfully, expressed in RFC 3339 timestamp format. Example: {@code 2019-04-03T21:10:29.600Z}

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current lifecycle state of the secret.

lifecycleState

lifecycleState: LifecycleState

The current lifecycle state of the secret.

Optional metadata

metadata: undefined | object

Additional metadata that you can use to provide context about how to use the secret or 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 nextRotationTime

nextRotationTime: Date

A property indicating when the secret is scheduled to be rotated, expressed in RFC 3339 timestamp format. Example: {@code 2019-04-03T21:10:29.600Z}

Optional rotationConfig

rotationConfig: model.RotationConfig

Optional rotationStatus

rotationStatus: RotationStatus

Additional information about the status of the secret rotation

Optional secretGenerationContext

secretName

secretName: string

The user-friendly name of the secret. Avoid entering confidential information.

Optional secretRules

secretRules: Array<SecretRule>

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

timeCreated

timeCreated: Date

A property indicating when the secret was created, expressed in RFC 3339 timestamp format. Example: {@code 2019-04-03T21:10:29.600Z}

Optional timeOfCurrentVersionExpiry

timeOfCurrentVersionExpiry: Date

An optional property indicating when the current secret version will expire, expressed in RFC 3339 timestamp format. Example: {@code 2019-04-03T21:10:29.600Z}

Optional timeOfDeletion

timeOfDeletion: Date

An optional property indicating when to delete the secret, expressed in RFC 3339 timestamp format. Example: {@code 2019-04-03T21:10:29.600Z}

vaultId

vaultId: string

The OCID of the vault where the secret exists.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Secret): object

getJsonObj

  • getJsonObj(obj: Secret): object