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:
LTO
Specifies the LTO device group.
3592
Specifies the 3592 device group.
DS5000
Specifies the DS5000 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.
DS8000_TCT
Specifies the DS8000_TCT device group that is in the GPFS device family.
BRCD_ENCRYPTOR
Specifies the BRCD_ENCRYPTOR device group that is in the LTO device family.
ONESECURE
Specifies the ONESECURE device group that is in the DS5000 device family.
GENERIC
Specifies a device family that uses KMIP to interact with IBM Security Guardium Key Lifecycle Manager. The GENERIC device group enables management of KMIP objects.

Do not use the command-line interface or REST interface to add a device to the GENERIC device group or to change a GENERIC device group attribute.

ETERNUS_DX
Specifies the ETERNUS_DX device group that is in the DS5000 device family.
XIV®
Specifies the XIV device group that is in the DS5000 device family.
userdevicegroup
Specifies a user-defined group that is based on a supported device family.
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:
drive.default.alias1
Specifies the system default certificate that a 3592 device uses if the device is not associated with another certificate.
drive.default.alias2
Specifies the system partner certificate that a 3592 device uses if the device is not associated with another certificate.
symmetricKeySet
Specifies a key group to be used for a device group.
shortName
Specifies a short label that is usually a drive type, such as LTO. This label is used for any additional attributes that are required by an original equipment manufacturer.
longName
Specifies an extended descriptive name of a drive type, such as my division LTO. For example, this information might include business information.

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 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"}
Success response
Status Code: 200 OK
{"code": "0","status": "Succeeded"}
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\"."}