Set Up Master Key REST Service

Use the Set Up Master Key REST Service to start using the master key in Unified Key Orchestrator (UKO). If the master key already exists in any other repository, all the cryptographic objects are again encrypted with the master key in the UKO repository. The encryption process might take time depending on the size of your database.

Operation
POST
URL
https://host:port/GKLM/rest/v1/ckms/masterKey/UKO/setupMasterKey

By default, IBM® Guardium Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM Guardium Key Lifecycle Manager installation, you can modify this default port.

Request

Request Parameters
Parameter Description
host Specify the IP address or hostname of the IBM Guardium Key Lifecycle Manager server.
port Specify the port number on which the IBM Guardium Key Lifecycle Manager server listens for requests.
Request Headers
Header name Value
Content-Type application/json
Accept application/json
Authorization SKLMAuth userAuthId=<authIdValue>
Accept-Language Any valid locale that is supported by IBM Guardium Key Lifecycle Manager. For example, en or de.

Response

Response Headers
Header name Value and description
Status Code
200 OK
The request was successful. The response body contains the requested representation.
400 Bad Request
The authentication information was not provided in the correct format.
401 Unauthorized
The authentication credentials were missing or incorrect.
404 Not Found Error
The processing of the request fails.
500 Internal Server Error
The processing of the request fails because of an unexpected condition on the server.
Content-Type application/json
Content-Language Locale for the response message.
Success response body

JSON object with the following specification.

JSON property name Description
code Returns the code that is specified by the status property.
status Returns the status message that indicates whether the backup was successful.
-1
State is unknown. The task is not run since the last time the IBM Guardium Key Lifecycle Manager server started.
0
The backup task succeeded.
1
The backup task failed.
2
Backup task succeeded with a warning.
Error Response Body

JSON object with the following specification.

JSON property name Description
code Returns the application error code.
message Returns a message that describes the error.

Examples

To import the UKO key pair, send this HTTP request:
POST https://host:port/GKLM/rest/v1/ckms/masterKey/UKO/setupMasterKey
Success response
{
  "code": "CTGKM3606I",
  "message": "CTGKM3606I Master key has been successfully set up in the UKO master key repository."
}