Public Key

URL:
https://<root>/publicKey
Methods:
GET
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.1

Description

The publicKey resource returns the server's public key, which can be used by client applications (or scripts) to encrypt data sent to the server using the RSA algorithm for public-key encryption. In addition to encrypting the sensitive parameters, the client is also required to send to the server an additional flag encrypted with value set to true. As the public key for the server can be changed at a later time, the client must fetch it on each request before encrypting the data sent to the server.

Request parameters

ParameterDescription

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the publicKey resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/admin/publicKey?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
{
  "publicKey": "<public key>",
  "modulus": "<modulus>"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
{
  "publicKey": "10001",
  "modulus": "a032f331acfa9d17ab5e30f75b2a311010cc01d4e8482d6a91abd7409a941099"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.