CertPrivateKey Property

The private key of the certificate (if available).

Syntax

 certmgr.getCertPrivateKey([callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getCertPrivateKey([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setCertPrivateKey([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The CertPrivateKey may be available, but not exportable. In this case, CertPrivateKey returns an empty string.

This property is read-only.

Data Type

String