Interface Key

interface Key {
    createdAt?: Date;
    description?: string;
    id: string;
    locked: boolean;
    name: string;
    origin: KeyOrigin;
    projectId: string;
    protected: boolean;
    region: Region;
    rotatedAt?: Date;
    rotationCount: number;
    rotationPolicy?: KeyRotationPolicy;
    state: KeyState;
    tags: string[];
    updatedAt?: Date;
    usage?: KeyUsage;
}

Properties

createdAt? description? id locked name origin projectId protected region rotatedAt? rotationCount rotationPolicy? state tags updatedAt? usage?

Properties

OptionalcreatedAt

createdAt?: Date

Key creation date.

Optionaldescription

description?: string

Description of the key.

id

id: string

ID of the key.

locked

locked: boolean

Returns true if the key is locked.

name

name: string

Name of the key.

origin

origin: KeyOrigin

Refer to the Key.Origin enum for a description of values.

projectId

projectId: string

ID of the Project containing the key.

protected

protected: boolean

Returns true if key protection is applied to the key.

region

region: Region

Region of the key.

OptionalrotatedAt

rotatedAt?: Date

Key last rotation date.

rotationCount

rotationCount: number

The rotation count tracks the amount of times that the key was rotated.

OptionalrotationPolicy

rotationPolicy?: KeyRotationPolicy

Key rotation policy.

state

state: KeyState

See the Key.State enum for a description of values.

tags

tags: string[]

List of the key's tags.

OptionalupdatedAt

updatedAt?: Date

Key last modification date.

Optionalusage

usage?: KeyUsage

Keys with a usage set to symmetric_encryption are used to encrypt and decrypt data. The only key algorithm currently supported by Key Manager is AES-256-GCM.

Settings

On This Page

Properties