Update Owner REST Service
Use Update Owner REST Service to update the owner of the KMIP objects to use the new client certificate.
- Operation
PUT
- URL
- https://<host>:<port>/SKLM/rest/v1/certificates/client
By default, Guardium® Key Lifecycle Manager server
listens to non-secure port 9080 (HTTP) and secure port 9443
(HTTPS) for communication. During IBM® Security Guardium Key Lifecycle Manager
installation, you can modify these default ports.
Note: The non-secure port 9080 is not applicable
when IBM Security Guardium Key Lifecycle Manager is deployed in a containerized
environment.
Before you begin
Authenticate to the IBM Security Guardium Key Lifecycle Manager by using your user name and password. For more information, see Authentication process for REST services.
Request
Request Parameters
Parameter | Description |
---|---|
host | Specify the IP address or host name of the IBM Security Guardium Key Lifecycle Manager server. |
port | Specify the port number on which the IBM Security 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 Security Guardium Key Lifecycle Manager. For example: en or de |
Request body
JSON property name | Description |
---|---|
oldAlias | Specify the alias of the old client certificate. |
newAlias | Specify the alias of the new client certificate. |
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
Content-Type | application/json |
Content-Language | Locale for the response message. |
Success response body
JSON object with the following specification:
JSON property name | Description |
---|---|
status | Returns the status to indicate whether the objects were updated to use the new client certificate. |
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
- Service request to update the owner of a KMIP object
PUT https://localhost:<port>/SKLM/rest/v1/certificates/client Content-Type: application/json Accept : application/json Authorization: SKLMAuth userAuthId=139aeh34567m Accept-Language : en { "oldAlias" : "client_cert", "newAlias":"newClient_cert"}
- Success response
Status Code : 200 OK Content-Language: en {"code":"0","status":"CTGKM0606I Update successful, change will take effect immediately"}
- Error response
Status Code : 400 Bad Request Content-Language: en {"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format"}