Access/acls: GET

Gets the list of all REST API access control lists (ACL).

Availability

Available on all IBM Storage Scale editions.

Description

The GET access/acls request gets the detailed information of all the REST API access control lists.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/access/acls

where

access/acls: Displays all the REST API acls. Required.

Request headers

Accept: application/json

Parameters

No parameters.

Request data

No request data.

Response data

{"status": {
    "code": Return Code,
    "message": "Return Message"
  },
  "acls": [
    {
      "userGroup": "user group name",
      "entries": [
        {
          "entryId": The access control entry ID,
          "type": "ALLOW| DENY",
          "method": "GET | POST | DELETE | PUT ",
          "uri": "Resource URL"
        }
      ]
    }
  ]
}

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

status:

Return status.

"code": ReturnCode,: The HTTPS Status code.
"message": "ReturnMessage": The detailed success or error message.

acls:

An array of information on the access control lists.

userGroup:

The user group for which the access control list is defined.

entries

The access control entries.

entryId: The REST API access control list entry ID.
type: The type of access provided. For example, Allow | Deny
method: The REST API request method which are GET | PUT | POST | DELETE
uri: The resource URL.

Examples

The following example gets information all the REST API ACLs.

Request data:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/access/acls'

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.

{
  "acls" : [ {
    "userGroup" : "Administrator",
    "entries" : [ {
      "entryId" : 1,
      "type" : "ALLOW",
      "method" : "GET",
      "uri" : "*"
    }, {
      "entryId" : 2,
      "type" : "ALLOW",
      "method" : "POST",
      "uri" : "/filesystems/*"
    } ]
  }, {
    "userGroup" : "ProtocolAdmin",
    "entries" : [ {
      "entryId" : 1,
      "type" : "ALLOW",
      "method" : "GET",
      "uri" : "*"
    }, {
      "entryId" : 2,
      "type" : "ALLOW",
      "method" : "POST",
      "uri" : "/filesystems/*"
    } ]
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}