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

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.
Form parameter
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 BEGIN CERTIFICATE and END CERTIFICATE statements.

alias

Specify an alias for the certificate.

usage

Specify the target application usage with the following values:

3592
Specifies the 3592 device group.
DS8000®
Specifies the DS8000 device group.
GPFS
Specifies the IBM Spectrum® Scale (previously known as GPFS) device group.
PEER_TO_PEER
Specifies the PEER_TO_PEER device group.
GENERIC
Specifies a device family that uses the Key Management Interoperability Protocol to interact with IBM Security Guardium Key Lifecycle Manager. The GENERIC device group enables management of KMIP objects.
SSLCLIENT
Specifies the client-side certificate that is used in secure communication by using Secure Socket Layer protocol to authenticate the client device.
SSLSERVER
Specifies the server-side certificate that is used in secure communication by using Secure Socket Layer protocol.
SYSLOG
Specifies the syslog server.
userdevicegroup
Specifies a user-defined group that is based on a supported device family.
format Specify the file format of the certificate.

You can specify one of the following possible values:

  • base64
  • DER
  • PEM
Where, DER is Distinguished Encoding Rules and PEM is Privacy Enhanced Mail. The default value is 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:
1
It indicates that the certificate must be trusted.
0
It indicates that the certificate is not trusted.
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:

3592
Specifies the 3592 device group.
DS8000
Specifies the DS8000 device group.
GPFS
Specifies the IBM Spectrum Scale (previously known as GPFS) device group.
PEER_TO_PEER
Specifies the PEER_TO_PEER device group.
GENERIC
Specifies a device family that uses the Key Management Interoperability Protocol to interact with IBM Security Guardium Key Lifecycle Manager. The GENERIC device group enables management of KMIP objects.
userdevicegroup
Specifies a user-defined group that is based on a supported device family.

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 a status message that indicates the import status.
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 direct import a certificate file
https://host:port/SKLM/rest/v1/objects/certificate/directimport
Success response
{
  "code": "0",
  "status": "Succeeded"
}