Salesforce

ClientCertificateAdd (Magic xpa 4.x)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

ClientCertificateAdd (Magic xpa 4.x)

Lets you define a certificate that will be sent for subsequent Invoke Web Services (using the Invoke Web Service Lite operation) and evaluate the HTTPCall, HTTPGet and HTTPPost functions (using the Evaluate operation).

Syntax:

ClientCertificateAdd (PKCS12-certificate, password)

Parameters:

PKCS12-Certificate – Public Key Cryptography Standard #12 is an industry format used for the transport, backup, and restoration of a certificate and its associated public and private key. This parameter must be an alphanumeric value.

Password – The Password can be a Null value when the certificate is exported without a password.

Returns:

True if a valid and authorized PKCS12 certificate was added or False when the:

  • Same certificate was added more than once.

  • Certificate does not exist.

  • Certificate is not in PKCS12 format.

  • Password is incorrect.

Example:

ClientCertificateAdd (my.pfx, %MY_PASS%) where:

my.pfx is the PKCS12 certificate.

%MY_PASS% is the logical name for the user's password.

Note:

All client certificates will remain active for the current context, sending subsequent calls, until the certificate is removed from the current context by using the ClientCertificateDiscard function. You can call the ClientCertificateAdd function several times to add multiple client certificates. You cannot add the same client certificate more than once. Certificates can be requested with an option to make the private key non-exportable, which means that PKCS12 certificates can not be imported to Magic xpa.

This function is supported only by HTTPFramework=S and HTTPFramework=J.

Exceptions:

This function is not supported for Rich Client and Web Client tasks.

See also:

SSL CA Certificate Files, SSL Client Certificate Files, and SSL Client Certificate Password environment settings

Reference
Attachment 
Attachment