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

Back to top

URL

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

Back to top

Sample Request

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

Request URL

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

Sample request headers

Accept: application/octet-stream

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept application/octet-stream
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
FedmemberID Path String Required Unique ID for a specific tenant, in a federation (multi-tenant) scenario; for example, acmepaymentscorp.
theme Path String Required The name of the platform theme.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

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.

Export certificate file for a tenant (tenantadmin service)

Back to top

Response Headers

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

Header Description
Content-Type application/octet-stream

Back to top

Response Body

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

Back to top

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.

Back to top

Related Topics