Certificate Update REST Service
Use the Certificate Update REST Service to update attributes or usage for a certificate.
3592
to a
user-defined device group, such as my3592
.
- Operation
PUT
- URL
- https://host:port/SKLM/rest/v1/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
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. |
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. |
JSON object with the following specification:
Property name | Description |
---|---|
uuid |
Specify the universal unique identifier of the certificate. |
attributes |
Specify one or more of the following attribute-value pairs:
|
usage |
Specify the target application usage such as SSLSERVER. You can specify the following values:
|
alias | Specify the alias of the certificate. |
default.alias1 | |
default.alias2 | |
in_use | Specify whether the certificate is in use. |
deviceTypeVersion | Specify the device type version of the certificate. |
deviceGroup | Specify the device group of the certificate. |
Response
Header name | Value and description |
---|---|
Status Code |
|
Content-Type | application/json |
Content-Language | Locale for the response message. |
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 to indicate whether the certificate is updated or not.
|
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 a certificate
PUT https://localhost:port/SKLM/rest/v1/certificates Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=139aeh34567m {"uuid":"CERTIFICATE-78d68704-fdde-42df-95da-debef9de9309","attributes": "trusted y"}
- Service request with incorrect usage
POST https://localhost:port/SKLM/rest/v1/certificates Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=139aeh34567m {"uuid":"CERTIFICATE-78d68704-fdde-42df-95da-debef9de9309","usage":"DS8000"} "usage":"3592"}