REST Resource: projects.locations.instances.mpc.keyRings

Resource: KeyRing

A KeyRing is a logical grouping of distributed Multi-party Compute (MPC) keys.

JSON representation
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "deleteTime": string,
  "labels": {
    string: string,
    ...
  }
}
Fields
name

string

Identifier. The unique resource name of the KeyRing. This field is server-assigned and follows the format required by AIP-122: projects/{project}/locations/{location}/instances/{instance}/mpc/keyRings/{keyRing}

displayName

string

Optional. User-assigned display name for the key ring.

createTime

string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The time at which the KeyRing was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

state

enum (State)

Output only. The state of the key ring.

deleteTime

string (Timestamp format)

Output only. The time at which the KeyRing was marked for deletion.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Optional. User-defined labels for grouping or filtering. e.g., {"env": "production", "team": "treasury"}

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

State

The state of the key ring.

Enums
STATE_UNSPECIFIED State is unspecified.
ACTIVE The key ring is active.
DELETED The key ring is deleted.

Methods

create

Creates a new KeyRing in a given project and location.

delete

Deletes a KeyRing.

get

Gets details of a single KeyRing.

list

Lists KeyRings in a given project and location.