Use the Group Entry Add REST Service to create a key group with the
specified number of keys and alias prefix. Your role must have a permission to the modify action and
a permission to the appropriate device group.
- Operation
POST- URL
- https://host:port/SKLM/rest/v1/keygroupentry
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. |
Request body
JSON
object with the following
specification:
| Parameter name |
Description |
| deviceType |
The device type of the devices that are associated with a key group. Possible
values are |
| key_group |
The name of the key group. |
| number_of_keys |
The number of keys that you want to add to the key group. |
| key_prefix |
The first three letters of the key name. It must be three alphabets. For
example, abc. |
| defaultAlias |
The default alias of the keys. |
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 addition
of key to the group 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 for adding a key to an existing group
POST https://localhost:<port>/SKLM/rest/v1/keygroupentry
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
{"name":"myGroup", "entry": "uuid KEY-a3ce9230-bef9-42bd-86b7-6d208ec119cf"}
- Success response
Status Code : 200 OK
{"code":"0","status":"Succeeded"}
- Service request to add a key when
an incorrect entry is specified
POST https://localhost:<port>/SKLM/rest/v1/keygroupentry
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
{"name":"myGroup", "entry": "alias aaa000000000000000002"}
- Error response
Status Code : 500 Internal Server Error
{"code":"CTGKM0565E","message":"CTGKM0565E Cannot find the key:
aaa000000000000000002"}