Documentation

Support

Services

Services

Secret Structure

Explore the fields that are contained within a secret.
Read time 1 minuteLast updated 17 hours ago

The secret is the fundamental unit of data in Secret Manager. It contains the sensitive data that you want to store securely and additional metadata that describes the secret. Refer to the table below for the fields that make up a secret.

Field

Type

Description

key
stringThe unique identifier for the secret. The key must be unique per hierarchy.
value
stringThe sensitive data that you want to store securely.
description
stringA brief description of the secret. This is optional, and can be left empty.
scope
project
,
organization
, or
environment
The level at which the secret is stored. Refer to Secret hierarchy.
overriddenScope
project
,
organization
,
environment
or
null
The level which the secret is overriding. This may be null.
creationDate
Timestamp in the RFC3339 formatThe time at which the secret was created.
lastUpdatedDate
Timestamp in the RFC3339 formatThe time at which the secret was last updated.
serviceAccess
Array of stringsThe list of Unity services that can access the secret. Refer to Service access for more information.
Refer to the Limits page for information on limits per field, and the limit for total secrets per hierarchy.