Client Configuration
GET /axis/about/v1/client/configuration
Provides details so the client may configure itself.
Response
HTTP 200
| Name | Type | Required | Description |
|---|---|---|---|
| encryptionEnabled | Boolean | Yes | Flag indicating if client/server encryption is enabled or not |
| encryption | Map | No | Map of client/server encryption settings. Required if encryptionEnabled is set to true |
| encryption.algorithm | String | Yes | The encryption algorithm to employ |
| encryption.version | String | Yes | The version identifier of the encryption configuration in use |
HTTP 500
Indicates an internal server error has occurred.
Example Response
{
"success": true,
"message": null,
"configurations": {
"encryptionEnabled": true,
"encryption": {
"version": "v1",
"algorithm": "AES-CBC-256"
}
}
}
Public Key
GET /axis/about/v1/publickey
Returns the public key used to securely exchange client/server encryption keys.
Response
HTTP 200
| Name | Type | Required | Description |
|---|---|---|---|
| publicKey | Map | Yes | Map of public key values |
| publicKey.pem | String | Yes | The PEM encoded public key |
| publicKey.algorithm | String | Yes | The encryption algorithm to employ |
| publicKey.version | String | Yes | The version identifier of the encryption configuration in use |
HTTP 401
Indicates that the user is not logged in.
HTTP 500
Indicates that an internal server error has occurred.
Example Response
{
"success": true,
"message": null,
"publicKey": {
"pem": "-----BEGIN PUBLIC KEY-----\n[BASE64 ENCODED DATA]\n-----END PUBLIC KEY-----",
"version": "v1",
"algorithm": "RSA-OAEP"
}
}