Class KmsCryptoClient

Hierarchy

KmsCryptoClient

Constructors

constructor

Properties

Accessors

endpoint

Methods

Constructors

constructor

new KmsCryptoClient(params: common.AuthParams): KmsCryptoClient

- Defined in lib/keymanagement/lib/client.ts:34
Parameters
- params: common.AuthParams
Returns KmsCryptoClient

Properties

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://kms.{region}.{secondLevelDomain}"

Accessors

endpoint

set endpoint(endpoint: string): void

- Defined in lib/keymanagement/lib/client.ts:47
Sets the endpoint to call (ex, https://www.example.com).

Parameters
- endpoint: string
  
  The endpoint of the service.
Returns void

Methods

decrypt

decrypt(decryptRequest: DecryptRequest): Promise<DecryptResponse>

- Defined in lib/keymanagement/lib/client.ts:58
Decrypts data using the given DecryptDataDetails resource.

throws

OciError when an error occurs

Parameters
- decryptRequest: DecryptRequest
Returns Promise<DecryptResponse>

DecryptResponse

encrypt

encrypt(encryptRequest: EncryptRequest): Promise<EncryptResponse>

- Defined in lib/keymanagement/lib/client.ts:115
Encrypts data using the given EncryptDataDetails resource. Plaintext included in the example request is a base64-encoded value of a UTF-8 string.

throws

OciError when an error occurs

Parameters
- encryptRequest: EncryptRequest
Returns Promise<EncryptResponse>

EncryptResponse

generateDataEncryptionKey

generateDataEncryptionKey(generateDataEncryptionKeyRequest: GenerateDataEncryptionKeyRequest): Promise<GenerateDataEncryptionKeyResponse>

- Defined in lib/keymanagement/lib/client.ts:171
Generates a key that you can use to encrypt or decrypt data.

throws

OciError when an error occurs

Parameters
- generateDataEncryptionKeyRequest: GenerateDataEncryptionKeyRequest
Returns Promise<GenerateDataEncryptionKeyResponse>

GenerateDataEncryptionKeyResponse