KMIP Template List REST Service

Use KMIP Template List REST Service to obtain the list of KMIP templates that IBM Security Guardium Key Lifecycle Manager provides.

Operation
GET
URL
https://host:port/SKLM/rest/v1/kmipTemplate

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.

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
Unique Identifier Returns the unique ID of the KMIP template.
Cryptographic Algorithm Returns the cryptographic algorithm of the KMIP template. For example, AES.
Cryptographic Length Returns the cryptographic length of the KMIP template.
Operation Policy Name Identifies operation policy that controls the key management operations on the KMIP template.
Cryptographic Usage Mask Returns the operation for which the KMIP template is used.
Usage Limits Returns the limit of the usage of the KMIP template.
Activation Date Returns the KMIP template activation date.
Process Start Date Returns the date and time when the KMIP template might begin to be used to process cryptographically protected information.
Process Stop Date Returns the date and time when the KMIP template will stop to be used to process cryptographically protected information.
Deactivation Date Identifies the date on which the KMIP template is deactivated.
Contact Information Represents the contact information.
Name Returns the name that identifies and locates the KMIP template.
Cryptographic Parameters Returns the parameters for cryptographic operations.
Object Group Returns the group that contains the KMIP template.
Application Specific Information Stores information specific to the application that uses the KMIP template.
Custom Attributes Returns the vendor defined custom attributes.
Initial Date Returns the initial date and time of the initialization of the KMIP template.
Last Changed Date Returns the date and time of the last change to the contents or attributes of the KMIP template.
Destroy Date Returns the date and time when the KMIP template was destroyed.
Archive Date Returns the KMIP template archived date.
Owner Defines the thumb-print reference of the creator of the KMIP template.
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.

Example

Service request to obtain a list of KMIP templates
GET https://localhost:<port>/SKLM/rest/v1/kmipTemplate
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
Success response
Status Code : 200 OK
[
    {
        "Unique Identifier": "K_TEMPLATE-a29fba3-fc151bbe-64bf-4648-adb3-a3ac7a35682d",
        "Cryptographic Algorithm": "",
        "Cryptographic Length": "",
        "Operation Policy Name": "",
        "Cryptographic Usage Mask": "",
        "Usage Limits": "",
        "Activation Date": "",
        "Process Start Date": "",
        "Protect Stop Date": "",
        "Deactivation Date": "",
        "Contact Information": "Joe",
        "Name": "[[INDEX 0] [TYPE TEXT] [VALUE Template1]]",
        "Cryptographic Parameters": "",
        "Object Group": "[[INDEX 0] [VALUE Group1]]",
        "Application Specific Information": "[[INDEX 0] [NAMESPACE ssl] [VALUE www.example.com]]" (http://www.example.com]]') ,
        "Custom Attributes": "[[NAME x-Purpose] [[INDEX 0] [TYPE JAVA_STRING] [VALUE demonstration]]]",
        "Initial Date": "12/13/18, 2:40:45 AM Eastern Standard Time",
        "Last Changed Date": "12/13/18, 7:40:45 AM Eastern Standard Time",
        "Destroy Date": "",
        "Archive Date": "",
        "Owner": ""
    }
]
Error response
Status Code : 400 Bad Request
Content-Language: en
{"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user 
authentication ID or invalid request format."}