Class API

constructor

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

• Parameters

  • client: Client

  Returns KeyManager.v1alpha1.API

Static ReadonlyLOCALITIES

createKey

• createKey(request: Readonly<CreateKeyRequest>): 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. Data encryption keys are not stored in Key Manager.

  Parameters

  • request: Readonly<CreateKeyRequest>

    The request CreateKeyRequest

  Returns Promise<Key>

  A Promise of Key

decrypt

• decrypt(request: Readonly<DecryptRequest>): Promise<DecryptResponse>

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

  Parameters

  • request: Readonly<DecryptRequest>

    The request DecryptRequest

  Returns Promise<DecryptResponse>

  A Promise of DecryptResponse

deleteKey

• deleteKey(request: Readonly<DeleteKeyRequest>): Promise<void>

• Delete a key. Permanently delete a key specified by the region and key_id parameters. This action is irreversible. Any data encrypted with this key, including data encryption keys, will no longer be decipherable.

  Parameters

  • request: Readonly<DeleteKeyRequest>

    The request DeleteKeyRequest

  Returns Promise<void>

deleteKeyMaterial

• deleteKeyMaterial(request: Readonly<DeleteKeyMaterialRequest>): 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: Readonly<DisableKeyRequest>): Promise<Key>

• Disable key. Disable a given key, preventing it 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: Readonly<EnableKeyRequest>): 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: Readonly<EncryptRequest>): Promise<EncryptResponse>

• Encrypt a payload. Encrypt a payload 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 64 KB of plaintext.

  Parameters

  • request: Readonly<EncryptRequest>

    The request EncryptRequest

  Returns Promise<EncryptResponse>

  A Promise of EncryptResponse

generateDataKey

• generateDataKey(request: Readonly<GenerateDataKeyRequest>): Promise<DataKey>

• Create a data encryption key. Create a new data encryption key for cryptographic operations outside of Key Manager. The data encryption key is encrypted and must be decrypted using the key you have created in Key Manager.

  The data encryption key is returned in plaintext and ciphertext but it should only be stored in its encrypted form (ciphertext). Key Manager does not store your data encryption key. To retrieve your key's plaintext, use the Decrypt method with your key's ID and ciphertext.

  Parameters

  • request: Readonly<GenerateDataKeyRequest>

    The request GenerateDataKeyRequest

  Returns Promise<DataKey>

  A Promise of DataKey

getKey

• getKey(request: Readonly<GetKeyRequest>): Promise<Key>

• Get key metadata. Retrieve metadata for a specified key using the region and key_id parameters.

  Parameters

  • request: Readonly<GetKeyRequest>

    The request GetKeyRequest

  Returns Promise<Key>

  A Promise of Key

importKeyMaterial

• importKeyMaterial(request: Readonly<ImportKeyMaterialRequest>): Promise<Key>

• Import key material. Import externally generated key material into Key Manager 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?: Readonly<ListKeysRequest>,
  ): Promise<ListKeysResponse> & {
      "[asyncIterator]": () => AsyncGenerator<Key[], void, void>;
      all: () => Promise<Key[]>;
  }

• List keys. Retrieve a list of keys across all Projects in an Organization or within a specific 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: Readonly<ProtectKeyRequest>): Promise<Key>

• Apply key protection. Apply 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: Readonly<RotateKeyRequest>): Promise<Key>

• Rotate a key. Generate a new version of an existing key with new key material. Previous key versions remain usable to decrypt previously encrypted data, but the key's new version 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: Readonly<UnprotectKeyRequest>): 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: Readonly<UpdateKeyRequest>): Promise<Key>

• Update a key. Modify a key's metadata including 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