GET /api/tenants/{FedmemberID}/theme/{theme}/pki/export

Exports PKI information for the specified tenant theme.

Authorization Roles/Permissions: Must be logged in. Must have Read permission for the business information; Site Admin.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/tenants/{FedmemberID}/theme/{theme}/pki/export

Sample Request

The example below shows a request for the PKI certificate for the acmepaymentscorp tenant, default theme.

Sample Request URL

https://{hostname}/api/tenants/acmepaymentscorp/theme/default/pki/export

Sample request headers

Accept: application/octet-stream

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/octet-stream
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
FedmemberID	Path	String	Required	Unique ID for a specific tenant. Same as TenantID.
theme	Path	String	Required	The name of the platform theme.

Response

If successful, this operation returns HTTP status code 200, with the certificate file for the specified theme.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Date: Thu, 11 Oct 2018 03:47:33 GMT
Content-Type: application/octet-stream
Content-Disposition: attachment; filename=certificate.cer

Sample response body: application/json

The response body is the certificate file.

In the example below, the operation is run in the browser (after login in a different browser tab) and the certificate file is returned.

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/octet-stream

Response Body

The response body is the certificate file, certificate.cer.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics