- URL:https://<site-url>/publicKey
- Required Capability:Default administrator role | All authorized privileges
- Version Introduced:10.1
Description
This resource returns the public key of the server that can be used by a client application (or script) 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.
Note:
You should not encrypt the values for the response format (f) or the token parameter.Request parameters
| Parameter | Description |
|---|---|
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample request URL for the publicKey resource:
https://machine.domain.com/webadaptor/admin/publicKey?f=jsonJSON Response syntax
{
"publicKey": "<public key>",
"modulus": "<modulus>"
}JSON Response example
{
"publicKey": "10001",
"modulus": "a032f331acfa9d17ab5e30f75b2a311010cc01d4e8482d6a91abd7409a941099"
}