Use Group Create REST
Service to create
a key group to which you can add keys.
- Operation
POST
- URL
- https://<host>:<port>/SKLM/rest/v1/keygroups/{groupName}
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 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. |
Path parameter
Parameter |
Description |
groupName |
Specify a unique name of the group to be created. |
Request
body
JSON object with the following
specification:
JSON property name |
Description |
usage |
Specify
the device to which this key group is
associated. For example, LTO . |
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 the status to indicate whether the group create task was
successful. |
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 create a group
POST https://localhost:<port>/SKLM/rest/v1/keygroups/newGroup
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
{"usage":"LTO"}
- Success response
Status Code: 200 OK
{"code":"0","status":"Succeeded"}
- Error response
Status Code: 400 Bad Request
{"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user
authentication ID or invalid request format."}
Status Code: 500 Internal Server Error
{"code":"CTGKM0583E","message":"CTGKM0583E Group already exists:
newGroup "}