Request Structure

URL: /certificate/download/format

Type: POST

Name Param Type Description Field Type Constraints
sessionId Header Session Id received after login. String Required if username and password are not provided.
username Header AppViewX login username. String Required if sessionId is not provided.
password Header AppViewX login password. String Required if sessionId is not provided.
Content-Type Header Specifies the nature of the data in the payload. String Value of the param should be ‘application/json’.
gwkey Query Tenant Key. This is needed only in case of multi tenant installations and can be ignored in other type of installations. String NA
gwsource Query Source from which the request is triggered (E.g. external). String NA
Payload Body Contains all the params to be sent in the request body for the post request. Payload NA
Payload
Name Mandatory Description Field Type Constraints
format Yes Format required. String

Format to download

Possible values are:

  1. CRT

  2. CERT

  3. CER

  4. PEM

  5. DER

  6. DERCER

  7. P7B

  8. P7C

  9. PK8

  10. P12

  11. PFX

  12. JKS
password No

Password for the certificate. Applicable for the following formats.

  1. P12

  2. PFX

  3. JKS

  4. PK8

 String

Mandatory if the format is -

  1. P12

  2. PFX

  3. JKS
commonName Yes Common name of the certificate. String NA
serialNumber Yes Serial number of the certificate. String NA
isChainRequired No Specifies whether the complete certificate chain has to be downloaded or the end certificate alone has to be downloaded. Boolean NA
isKeyEncryptionRequired No Specifies whether the private key needs to be encrypted using password. Boolean

This is applicable for PK8 format.

If true, make sure that the Certificate policy allows private key access.

If true, then password must be provided in the request payload.