Device Group Attribute Delete REST Service
Use Device Group Attribute Delete REST Service to
delete an attribute of a device group, such as myLTO
.
- Operation
DELETE
- URL
- https://<host>:<port>/SKLM/rest/v1/deviceGroupAttributes
By default, Guardium® Key Lifecycle Manager server
listens to non-secure port 9080 (HTTP) and secure port 9443
(HTTPS) for communication. During IBM® Security Guardium Key Lifecycle Manager
installation, you can modify these default ports.
Note: The non-secure port 9080 is not applicable
when IBM Security Guardium Key Lifecycle Manager is deployed in a containerized
environment.
Request
Request Parameters
Parameter | Description |
---|---|
host | Specify the IP address or host name 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:
JSON property name | Description |
---|---|
name | Required. Specify a unique device group, such
as LTO , with the following values:
|
attribute | Required. Specify one or more user-defined attribute-value
pairs. Use Device Group Attribute List REST Service to
view the current value. You have the following choices:
|
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
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 device group attribute deletion is 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 delete an attribute
DELETE http://localhost/SKLM/rest/v1/deviceGroupAttributes Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=139aeh34567m {"name":"myLTO","attributes":"symmetricKeySet"}
- Service request to delete an attribute when an invalid parameter is specified
DELETE http://localhost/SKLM/rest/v1/deviceGroupAttributes Content-Type: application/json Accept: application/json Authorization: SKLMAuth userAuthId=139aeh34567m {"Name":"myLTO","attribute":"longName, shortName"}
- Error response
Status Code: 400 Bad Request {"code":"CTGKM0630E","message":"CTGKM0630E Validation error: \"Invalid name \" for parameter \"Name\"."}