Access/acls/{userGroup}/entry/{entryId}: DELETE

Deletes a specified REST API access control lists (ACL) entry that is defined for a user group.

Availability

Available on all IBM Storage Scale editions.

Description

The DELETE access/acls/{userGroup}/entry/{entryID} command deletes the specified ACL entry that is defined for a user group.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/access/acls/userGroup/entry/entryId
where:
acls/userGroup
Specifies the user group with which the ACL entries are associated. Required.
entry/entryId
Specifies the ACL entry ID that needs to be deleted. Required.

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
userGroup The name of the user group for which the ACL entries are defined. Required.
entryID The ID of the ACL entry that is to be deleted. Required.

Response data

{
    "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   jobs: [
      {
         "result":"", 
           { 
             "commands":"command names",
             "progress":"progress information,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"Messages", 
           },
         "request":" ",
           {
             "type":"{GET | POST | PUT | DELETE}",
             "url":"URL",
             "data":""",
           }
         "jobId":"ID",
         "submitted":"Time",
         "completed":Time",
         "runtime":Time",
         "status":"RUNNING | CANCELLING | CANCELLED |COMPLETED | FAILED",
         "pids":"Process IDs
          }   
        ],
   }

The details of the parameters are provided in the following list:

"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"jobs":
An array of elements that describe jobs. Each element describes one job.
"result"
"commands":"command names'
Array of commands that are run in this job.
"progress":"information'
Progress information for the request.
"exitCode":"Exit code"
The Exit code of command. The value zero denotes success and nonzero denotes failure.
"stderr":"Error"
CLI messages from. stderr.
"stdout":"message"
CLI messages from stdout.
"request"
"type":"{GET | POST | PUT | DELETE}"
HTTP request type.
"url":"URL"
The URL through which the job is submitted.
"data":"job data "
The data that was posted when the job was submitted.
"jobId":"ID",
The unique ID of the job.
"submitted":"Time"
The time at which the job was submitted.
"completed":Time"
The time at which the job was completed.
"runtime":Time
The runtime of the job in milliseconds.
"status":"RUNNING | COMPLETED | FAILED| CANCELLING |CANCELLED"
Status of the job.
"pids": "Process IDs"
The process IDs of all the active sub processes that are started to manage the job.

Examples

The following example deletes the ACL entry with the ID 1 from the user group CSI Admin.

Request data: 
curl -k -u admin:admin001 -X DELETE --header 'accept:application/json' 
'https:///198.51.100.1:443/scalemgmt/v2/access/acls/CsiAdmin/entry/1'
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 
{
  "jobs" : [ {
    "jobId" : 1000000000017,
    "status" : "COMPLETED",
    "submitted" : "2021-01-30 18:29:58,512",
    "completed" : "2021-01-30 18:29:59,026",
    "runtime" : 514,
    "request" : {
      "type" : "DELETE",
      "url" : "/scalemgmt/v2/access/acls/CsiAdmin/entry/1"
    },
    "result" : {
      "progress" : [ ],
      "commands" : [ "mv --force '/var/lib/mmfs/gui/settings.json.6d00b312-8bba-4645-bee8-0996b4f3dbc6' '/var/lib/mmfs/gui/settings.json' " ],
      "stdout" : [ "info: chrestacl CsiAdmin remove --entryId 1 --force --verbose " ],
      "stderr" : [ ],
      "exitCode" : 0
    },
    "pids" : [ ]
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}