Security
The Security operations that can be performed on the Business Directory resources are:
| • | GET /security/backup_encryption_settings |
| • | GET /security/generateUUID |
| • | POST /security/import_encryption_settings |
| • | GET /security/systemEncryption |
| • | PUT /security/systemEncryption |
GET /security/backup_encryption_settings
This API is used to backup the encryption settings to a password protected file for server recovery in case of emergency.
Parameters
|
Name |
Description |
Parameter Type |
Data Type |
|
encryptionPassword |
Password used by the encryption utility |
query |
string |
Example to backup the encryption settings
curl -X GET -u admin:admin "https://localhost:9502/rest/v2/security/backup_encryption_settings?encryptionPassword=testPassword" -o backup_encryption_settings.txt
GET /security/generateUUID
This API is used to get the system randomly generated UUID.
Parameters
None
Example to get the system randomly generated UUID.
curl -X GET -u admin:admin "https://localhost:9502/rest/v2/security/generateUUID"
POST /security/import_encryption_settings
This API is used to restore the encryption settings from the backup file. You must know the password that was used to protect the backup file.
Parameters
|
Name |
Description |
Parameter Type |
Data Type |
|
file |
|
|
object |
|
encryptionPassword |
|
body |
string |
Example to restore the encryption settings
curl -u "admin:admin" -i -F "encryptionPassword=testPassword" -F "file=@backup_encryption_settings.txt" -X POST "https://localhost:9502/rest/v2/security/import_encryption_settings"
GET /security/systemEncryption
This API is used to get the system encryption settings.
Parameters
None
Example to get the system encryption settings.
curl -X GET -u admin:admin "https://localhost:9502/rest/v2/security/systemEncryption"
PUT /security/systemEncryption
This API is used to update the system encryption settings. Can take a long time in large database to re-encrypt data.
Parameters
None
Request Body
{"algorithm": "string",
"password": "string",
"uuid": "string",
"keySize": "string"
}
Example to update the system encryption settings
curl -X PUT -u admin:admin "https://localhost:9502/rest/v2/security/systemEncryption" -H "Content-Type:application/json" -d "{\"password\":\"MyTestEncryptionPassword\",\"uuid\":\"0b352e1e-ab56-4271-a813-31183df63788\"}"