Update System Certificate REST Service
Use the Update System Certificate REST Service to update the usage type of a certificate.
- Operation
PUT
- URL
- https://host:port/SKLM/rest/v1/system/certificates
By default, Guardium Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM Security 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 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 object with the following specification:
JSON property name | Description |
---|---|
alias | Specify the alias of the certificate that you want to update. |
addUsageSubtype | Specify the usage type that you want to add to this certificate. You can
specify multiple usage types in comma-separated format.
|
removeUsageSubtype | Specify the usage type that you want to add to this certificate. You can
specify multiple usage types in comma-separated format.
|
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 |
---|---|
code | Returns the code that is specified by the status property. |
status | Returns the status to indicate whether the usage type is updated successfully. |
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 usage type of a certificate
-
PUT https://localhost:port/SKLM/rest/v1/system/certificates { "alias": "server_cert", "addUsageSubtype": "EKMF_TLS, SERVERGUI_TLS", "removeUsageSubtype": "KEYSERVING_TLS" }
- Invalid service request where the usage type is incorrect
-
PUT https://localhost:port/SKLM/rest/v1/system/certificates?usageSubtype=SERVERGUI_TLS { "alias": "server_cert2", "addUsageSubtype": "EKMF TLS" }