REST Resource: projects.secrets

Resource: Secret

A Secret is a logical secret whose value and versions can be accessed.

A Secret is made up of zero or more SecretVersions that represent the secret data.

JSON representation 
{
  "name": string,
  "replication": {
    object (Replication)
  },
  "createTime": string,
  "labels": {
    string: string,
    ...
  }
}
Fields
name

string

Output only. The resource name of the Secret in the format projects/*/secrets/*.
replication

object (Replication)

Required. Immutable. The replication policy of the secret data attached to the Secret.

The replication policy cannot be changed after the Secret has been created.
createTime

string (Timestamp format)

Output only. The time at which the Secret was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

The labels assigned to this Secret.

Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}

Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

No more than 64 labels can be assigned to a given resource.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Replication

A policy that defines the replication configuration of data.

JSON representation 
{

  // Union field replication can be only one of the following:
  "automatic": {
    object (Automatic)
  },
  "userManaged": {
    object (UserManaged)
  }
  // End of list of possible types for union field replication.
}
Fields
Union field replication. The replication policy for this secret. replication can be only one of the following:
automatic

object (Automatic)

The Secret will automatically be replicated without any restrictions.
userManaged

object (UserManaged)

The Secret will only be replicated into the locations specified.

Automatic

A replication policy that replicates the Secret payload without any restrictions.

UserManaged

A replication policy that replicates the Secret payload into the locations specified in [Secret.replication.user_managed.replicas][]

JSON representation 
{
  "replicas": [
    {
      object (Replica)
    }
  ]
}
Fields
replicas[]

object (Replica)

Required. The list of Replicas for this Secret.

Cannot be empty.

Replica

Represents a Replica for this Secret.

JSON representation 
{
  "location": string
}
Fields
location

string

The canonical IDs of the location to replicate data. For example: "us-east1".

Methods

addVersion

 Creates a new SecretVersion containing secret data and attaches it to an existing Secret.

create

 Creates a new Secret containing no SecretVersions.

delete

 Deletes a Secret.

get

 Gets metadata for a given Secret.

getIamPolicy

 Gets the access control policy for a secret.

list

 Lists Secrets.

patch

 Updates metadata of an existing Secret.

setIamPolicy

 Sets the access control policy on the specified secret.

testIamPermissions

 Returns permissions that a caller has for the specified secret.