Certificate Direct Import REST Service
Use the Certificate Direct Import REST Service to import a certificate file to the IBM Security Guardium Key Lifecycle Manager server directly from your system, without having to upload the certificate file to the server first.
- Operation
POST
- URL
- https://host:port/SKLM/rest/v1/certificates/directimport
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. |
Parameter name | Description |
---|---|
fileName | This parameter is mandatory if the certText parameter is
not specified. Select the certificate file that you want to import. |
certText | This parameter is mandatory if the fileName parameter is
not specified. Enter the certificate content. The certificate content must include the
|
alias |
Specify an alias for the certificate. |
usage |
Specify the target application usage with the following values:
|
format | Specify the file format of the certificate. You can specify one of the following possible values:
base64 . |
deviceRole | Specify the device role. You can specify the following possible values:
owner , partner . |
trusted | Specify whether the certificate is trusted by the server or not. You can
specify the following possible values:
|
deviceGroup | When the usage parameter is set to
SSLCLIENT , specify the device group name for which this certificate is to be used
as the communication certificate.You can specify the following possible values:
|
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 a status message that indicates the import status. |
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 direct import a certificate file
-
https://host:port/SKLM/rest/v1/objects/certificate/directimport
- Success response
-
{ "code": "0", "status": "Succeeded" }