Class API

constructor

• new API(client): KeyManager.v1alpha1.API

• Parameters

  • client: Client

  Returns KeyManager.v1alpha1.API

Static ReadonlyLOCALITIES

createKey

• createKey(request): Promise<Key>

• Create a key. Create a key in a given region specified by the region parameter. Keys only support symmetric encryption. You can use keys to encrypt or decrypt arbitrary payloads, or to generate data encryption keys that can be used without being stored in Key Manager.

  Parameters

  • request: Readonly<CreateKeyRequest>

    The request CreateKeyRequest

  Returns Promise<Key>

  A Promise of Key

decrypt

• decrypt(request): Promise<DecryptResponse>

• Decrypt data. Decrypt data using an existing key, specified by the key_id parameter. The maximum payload size that can be decrypted is the result of the encryption of 64KB of data (around 131KB).

  Parameters

  • request: Readonly<DecryptRequest>

    The request DecryptRequest

  Returns Promise<DecryptResponse>

  A Promise of DecryptResponse

deleteKey

• deleteKey(request): Promise<void>

• Delete a key. Delete an existing key specified by the region and key_id parameters. Deleting a key is permanent and cannot be undone. All data encrypted using this key, including data encryption keys, will become unusable.

  Parameters

  • request: Readonly<DeleteKeyRequest>

    The request DeleteKeyRequest

  Returns Promise<void>

deleteKeyMaterial

• deleteKeyMaterial(request): Promise<void>

• Delete key material. Delete previously imported key material. This renders the associated cryptographic key unusable for any operation. The key's origin must be external.

  Parameters

  • request: Readonly<DeleteKeyMaterialRequest>

    The request DeleteKeyMaterialRequest

  Returns Promise<void>

disableKey

• disableKey(request): Promise<Key>

• Disable key. Disable a given key to be used for cryptographic operations. Disabling a key renders it unusable. You must specify the region and key_id parameters.

  Parameters

  • request: Readonly<DisableKeyRequest>

    The request DisableKeyRequest

  Returns Promise<Key>

  A Promise of Key

enableKey

• enableKey(request): Promise<Key>

• Enable key. Enable a given key to be used for cryptographic operations. Enabling a key allows you to make a disabled key usable again. You must specify the region and key_id parameters.

  Parameters

  • request: Readonly<EnableKeyRequest>

    The request EnableKeyRequest

  Returns Promise<Key>

  A Promise of Key

encrypt

• encrypt(request): Promise<EncryptResponse>

• Encrypt data. Encrypt data using an existing key, specified by the key_id parameter. Only keys with a usage set to symmetric_encryption are supported by this method. The maximum payload size that can be encrypted is 64KB of plaintext.

  Parameters

  • request: Readonly<EncryptRequest>

    The request EncryptRequest

  Returns Promise<EncryptResponse>

  A Promise of EncryptResponse

generateDataKey

• generateDataKey(request): Promise<DataKey>

• Generate a data encryption key. Generate a new data encryption key to use for cryptographic operations outside of Key Manager. Note that Key Manager does not store your data encryption key. The data encryption key is encrypted and must be decrypted using the key you have created in Key Manager. The data encryption key's plaintext is returned in the response object, for immediate usage.

  Always store the data encryption key's ciphertext, rather than its plaintext, which must not be stored. To retrieve your key's plaintext, call the Decrypt endpoint with your key's ID and ciphertext.

  Parameters

  • request: Readonly<GenerateDataKeyRequest>

    The request GenerateDataKeyRequest

  Returns Promise<DataKey>

  A Promise of DataKey

getKey

• getKey(request): Promise<Key>

• Get key metadata. Retrieve the metadata of a key specified by the region and key_id parameters.

  Parameters

  • request: Readonly<GetKeyRequest>

    The request GetKeyRequest

  Returns Promise<Key>

  A Promise of Key

importKeyMaterial

• importKeyMaterial(request): Promise<Key>

• Import key material. Import key material to use to derive a new cryptographic key. The key's origin must be external.

  Parameters

  • request: Readonly<ImportKeyMaterialRequest>

    The request ImportKeyMaterialRequest

  Returns Promise<Key>

  A Promise of Key

listKeys

• listKeys(request?): Promise<ListKeysResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Key[], void, void>);
      all: (() => Promise<Key[]>);
  }

• List keys. Retrieve the list of keys created within all Projects of an Organization or in a given Project. You must specify the region, and either the organization_id or the project_id.

  Parameters

  • request: Readonly<ListKeysRequest> = {}

    The request ListKeysRequest

  Returns Promise<ListKeysResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Key[], void, void>);
      all: (() => Promise<Key[]>);
  }

  A Promise of ListKeysResponse

protectKey

• protectKey(request): Promise<Key>

• Apply key protection. Apply key protection to a given key specified by the key_id parameter. Applying key protection means that your key can be used and modified, but it cannot be deleted.

  Parameters

  • request: Readonly<ProtectKeyRequest>

    The request ProtectKeyRequest

  Returns Promise<Key>

  A Promise of Key

rotateKey

• rotateKey(request): Promise<Key>

• Rotate a key. Generate a new version of an existing key with randomly generated key material. Rotated keys can still be used to decrypt previously encrypted data. The key's new material will be used for subsequent encryption operations and data key generation.

  Parameters

  • request: Readonly<RotateKeyRequest>

    The request RotateKeyRequest

  Returns Promise<Key>

  A Promise of Key

unprotectKey

• unprotectKey(request): Promise<Key>

• Remove key protection. Remove key protection from a given key specified by the key_id parameter. Removing key protection means that your key can be deleted anytime.

  Parameters

  • request: Readonly<UnprotectKeyRequest>

    The request UnprotectKeyRequest

  Returns Promise<Key>

  A Promise of Key

updateKey

• updateKey(request): Promise<Key>

• Update a key. Update a key's metadata (name, description and tags), specified by the key_id and region parameters.

  Parameters

  • request: Readonly<UpdateKeyRequest>

    The request UpdateKeyRequest

  Returns Promise<Key>

  A Promise of Key