SMB/shares/{shareName}/acl: GET

Gets information about access control lists (ACL) that are specific to an SMB share.

Availability

Available on all IBM Storage Scale editions.

Description

The GET smb/shares/shareName/acl request gets information about the ACLs that are applicable to the specified SMB share. For more information about the fields in the data structures that are returned, see mmsmb command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/smb/shares/shareName/acl
where
smb/shares
Specifies the SMB share as the resource. Required.
shareName/acl
Specifies the SMB share for which you need to get the ACL details. Required.

Request headers

Accept: application/json

Request parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of request parameters
Parameter name Description and applicable keywords Required/optional
fields Comma separated list of fields to be included in response. ':all:' selects all available fields. Optional.
shareName Name of the SMB share. Required.

Request data

No request data.

Response data

The following list of attributes are available in the response data: 


{      
"status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   "paging": 
    {
      "next":URL",
      "fields":"Fileds in request"
      "filter":"Filter in request"
      "baseUrl":"Base URL"
      "lastId":"ID"
       },
  "entries": 
    {
         "shareName": "Share name"
         "name": "ACL name"
         "access": "Allowed | Denied"
         "permissions": "Access permissions",     
         "type": "User | Group | System | UID",  
      ),
The details of the parameters are given in the following list:
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"paging"
Paging is enabled when more than 1000 objects are returned by the query.
"next":URL"
The URL to retrieve the next page.
"fields":"Fileds in the request"
The fields used in the original request.
"filter":"Filter in request"
The filter used in the original request.
"baseUrl":"Base URL"
The URL of the request without any parameters.
"lastId":"ID"
The ID of the last element that can be used to retrieve the next elements.
"entries":
An array of information about an ACL that is applied to an SMB share.
"sharename": "String"
Name of the SMB share.
"name": "ACL name"
The name of the ACL.
"access": "Allowed | Denied"
Specifies whether the user is allowed or denied to access the resource.
"permissions": "Access permissions"
The permissions set for the ACL. Possible values are: FULL, CHANGE, READ or any combination of RWXDPO.
"type": "User | Group | System | UID"
Specifies the ACL type. The value selected is used only when creating an access control entry.

Examples

The following example gets information about the ACL of the SMB share share1.

Request URL: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/smb/shares/share1/acl'
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. 
{
  "status": {
    "code": 200,
    "message": "..."
  },
  "paging": {
    "next": "https://localhost:443/scalemgmt/v2/smb/shares/share1/acl?lastId=10001",
    "fields": "",
    "filter": "",
    "baseUrl": "smb/shares/share1/acl",
    "lastId": 10001
  },
  "entries": [
    {
      "shareName": "myshare",
      "name": "Domain1\\User3",
      "access": "ALLOWED",
      "permissions": "FULL",
      "type": "USER"
    }
  ]
}