Endpoint
/v2/files/{ref}/info/acl
GET
Get file access control list (ACL).
Parameters
Name
Description
Required
refThe file ID or the absolute path to the file system object. File IDs can be found in the id field of responses of APIs that return file attributes. You must URL-encode the paths. The APIs & Tools page in the Qumulo Core Web UI URL-encodes the paths.
Yes
snapshotThe snapshot ID that specifies the version of the filesystem to use. If not specified, use the head version.
No
Response
Codes
Code
Description
200
Return value on success
Schema
{
"description" : "api_files_acl_v2" ,
"type" : "object" ,
"properties" : {
"control" : {
"description" : "control" ,
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"PRESENT" ,
"DEFAULTED" ,
"TRUSTED" ,
"AUTO_INHERIT" ,
"PROTECTED" ,
"ALL"
],
"description" : "control: \n * `ALL` - API_FILES_ACL_CONTROL_ALL, \n * `AUTO_INHERIT` - API_FILES_ACL_CONTROL_AUTO_INHERIT, \n * `DEFAULTED` - API_FILES_ACL_CONTROL_DEFAULTED, \n * `PRESENT` - API_FILES_ACL_CONTROL_PRESENT, \n * `PROTECTED` - API_FILES_ACL_CONTROL_PROTECTED, \n * `TRUSTED` - API_FILES_ACL_CONTROL_TRUSTED"
}
},
"posix_special_permissions" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"STICKY_BIT" ,
"SET_GID" ,
"SET_UID"
],
"description" : "posix_special_permissions: \n * `SET_GID` - SET_GID, \n * `SET_UID` - SET_UID, \n * `STICKY_BIT` - STICKY_BIT"
}
},
"aces" : {
"type" : "array" ,
"items" : {
"description" : "aces" ,
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string" ,
"enum" : [
"ALLOWED" ,
"DENIED"
],
"description" : "Type of this ACL entry: \n * `ALLOWED` - API_FILES_ACE_TYPE_ALLOWED, \n * `DENIED` - API_FILES_ACE_TYPE_DENIED"
},
"flags" : {
"description" : "ACE flags for this ACL entry" ,
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"OBJECT_INHERIT" ,
"CONTAINER_INHERIT" ,
"NO_PROPAGATE_INHERIT" ,
"INHERIT_ONLY" ,
"INHERITED" ,
"ALL"
],
"description" : "ACE flags for this ACL entry: \n * `ALL` - API_FILES_ACE_FLAG_ALL, \n * `CONTAINER_INHERIT` - API_FILES_ACE_FLAG_CONTAINER_INHERIT, \n * `INHERITED` - API_FILES_ACE_FLAG_INHERITED, \n * `INHERIT_ONLY` - API_FILES_ACE_FLAG_INHERIT_ONLY, \n * `NO_PROPAGATE_INHERIT` - API_FILES_ACE_FLAG_NO_PROPAGATE_INHERIT, \n * `OBJECT_INHERIT` - API_FILES_ACE_FLAG_OBJECT_INHERIT"
}
},
"trustee" : {
"description" : "Trustee for this ACL entry" ,
"type" : "object" ,
"properties" : {
"domain" : {
"type" : "string" ,
"enum" : [
"LOCAL" ,
"API_NULL_DOMAIN" ,
"WORLD" ,
"POSIX_USER" ,
"POSIX_GROUP" ,
"ACTIVE_DIRECTORY" ,
"API_INVALID_DOMAIN" ,
"API_RESERVED_DOMAIN" ,
"API_INTERNAL_DOMAIN" ,
"API_OPERATOR_DOMAIN" ,
"API_CREATOR_DOMAIN"
],
"description" : "domain: \n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY, \n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN, \n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN, \n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN, \n * `API_NULL_DOMAIN` - API_NULL_DOMAIN, \n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN, \n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN, \n * `LOCAL` - LOCAL, \n * `POSIX_GROUP` - POSIX_GROUP, \n * `POSIX_USER` - POSIX_USER, \n * `WORLD` - WORLD"
},
"auth_id" : {
"description" : "auth_id" ,
"type" : "string"
},
"uid" : {
"description" : "uid" ,
"type" : "number"
},
"gid" : {
"description" : "gid" ,
"type" : "number"
},
"sid" : {
"description" : "sid" ,
"type" : "string"
},
"name" : {
"description" : "name" ,
"type" : "string"
}
}
},
"rights" : {
"description" : "Rights granted or denied for this ACL entry" ,
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"READ" ,
"READ_EA" ,
"READ_ATTR" ,
"READ_ACL" ,
"WRITE_EA" ,
"WRITE_ATTR" ,
"WRITE_ACL" ,
"CHANGE_OWNER" ,
"WRITE_GROUP" ,
"DELETE" ,
"EXECUTE" ,
"MODIFY" ,
"EXTEND" ,
"ADD_FILE" ,
"ADD_SUBDIR" ,
"DELETE_CHILD" ,
"SYNCHRONIZE" ,
"ALL"
],
"description" : "Rights granted or denied for this ACL entry: \n * `ADD_FILE` - API_FILES_ACCESS_ADD_FILE, \n * `ADD_SUBDIR` - API_FILES_ACCESS_ADD_SUBDIR, \n * `ALL` - API_FILES_ACCESS_ALL, \n * `CHANGE_OWNER` - API_FILES_ACCESS_CHANGE_OWNER, \n * `DELETE` - API_FILES_ACCESS_DELETE, \n * `DELETE_CHILD` - API_FILES_ACCESS_DELETE_CHILD, \n * `EXECUTE` - API_FILES_ACCESS_EXECUTE, \n * `EXTEND` - API_FILES_ACCESS_EXTEND, \n * `MODIFY` - API_FILES_ACCESS_MODIFY, \n * `READ` - API_FILES_ACCESS_READ, \n * `READ_ACL` - API_FILES_ACCESS_READ_ACL, \n * `READ_ATTR` - API_FILES_ACCESS_READ_ATTR, \n * `READ_EA` - API_FILES_ACCESS_READ_EA, \n * `SYNCHRONIZE` - API_FILES_ACCESS_SYNCHRONIZE, \n * `WRITE_ACL` - API_FILES_ACCESS_WRITE_ACL, \n * `WRITE_ATTR` - API_FILES_ACCESS_WRITE_ATTR, \n * `WRITE_EA` - API_FILES_ACCESS_WRITE_EA, \n * `WRITE_GROUP` - API_FILES_ACCESS_WRITE_GROUP"
}
}
}
}
}
}
} PUT
Update file access control list (ACL).
Parameters
Name
Description
Required
refThe file ID or the absolute path to the file system object. File IDs can be found in the id field of responses of APIs that return file attributes. You must URL-encode the paths. The APIs & Tools page in the Qumulo Core Web UI URL-encodes the paths.
Yes
If-MatchETag for expected version
No
Request
Schema
{
"description" : "api_files_acl_v2" ,
"type" : "object" ,
"properties" : {
"control" : {
"description" : "control" ,
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"PRESENT" ,
"DEFAULTED" ,
"TRUSTED" ,
"AUTO_INHERIT" ,
"PROTECTED" ,
"ALL"
],
"description" : "control: \n * `ALL` - API_FILES_ACL_CONTROL_ALL, \n * `AUTO_INHERIT` - API_FILES_ACL_CONTROL_AUTO_INHERIT, \n * `DEFAULTED` - API_FILES_ACL_CONTROL_DEFAULTED, \n * `PRESENT` - API_FILES_ACL_CONTROL_PRESENT, \n * `PROTECTED` - API_FILES_ACL_CONTROL_PROTECTED, \n * `TRUSTED` - API_FILES_ACL_CONTROL_TRUSTED"
}
},
"posix_special_permissions" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"STICKY_BIT" ,
"SET_GID" ,
"SET_UID"
],
"description" : "posix_special_permissions: \n * `SET_GID` - SET_GID, \n * `SET_UID` - SET_UID, \n * `STICKY_BIT` - STICKY_BIT"
}
},
"aces" : {
"type" : "array" ,
"items" : {
"description" : "aces" ,
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string" ,
"enum" : [
"ALLOWED" ,
"DENIED"
],
"description" : "Type of this ACL entry: \n * `ALLOWED` - API_FILES_ACE_TYPE_ALLOWED, \n * `DENIED` - API_FILES_ACE_TYPE_DENIED"
},
"flags" : {
"description" : "ACE flags for this ACL entry" ,
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"OBJECT_INHERIT" ,
"CONTAINER_INHERIT" ,
"NO_PROPAGATE_INHERIT" ,
"INHERIT_ONLY" ,
"INHERITED" ,
"ALL"
],
"description" : "ACE flags for this ACL entry: \n * `ALL` - API_FILES_ACE_FLAG_ALL, \n * `CONTAINER_INHERIT` - API_FILES_ACE_FLAG_CONTAINER_INHERIT, \n * `INHERITED` - API_FILES_ACE_FLAG_INHERITED, \n * `INHERIT_ONLY` - API_FILES_ACE_FLAG_INHERIT_ONLY, \n * `NO_PROPAGATE_INHERIT` - API_FILES_ACE_FLAG_NO_PROPAGATE_INHERIT, \n * `OBJECT_INHERIT` - API_FILES_ACE_FLAG_OBJECT_INHERIT"
}
},
"trustee" : {
"description" : "Trustee for this ACL entry" ,
"type" : "object" ,
"properties" : {
"domain" : {
"type" : "string" ,
"enum" : [
"LOCAL" ,
"API_NULL_DOMAIN" ,
"WORLD" ,
"POSIX_USER" ,
"POSIX_GROUP" ,
"ACTIVE_DIRECTORY" ,
"API_INVALID_DOMAIN" ,
"API_RESERVED_DOMAIN" ,
"API_INTERNAL_DOMAIN" ,
"API_OPERATOR_DOMAIN" ,
"API_CREATOR_DOMAIN"
],
"description" : "domain: \n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY, \n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN, \n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN, \n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN, \n * `API_NULL_DOMAIN` - API_NULL_DOMAIN, \n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN, \n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN, \n * `LOCAL` - LOCAL, \n * `POSIX_GROUP` - POSIX_GROUP, \n * `POSIX_USER` - POSIX_USER, \n * `WORLD` - WORLD"
},
"auth_id" : {
"description" : "auth_id" ,
"type" : "string"
},
"uid" : {
"description" : "uid" ,
"type" : "number"
},
"gid" : {
"description" : "gid" ,
"type" : "number"
},
"sid" : {
"description" : "sid" ,
"type" : "string"
},
"name" : {
"description" : "name" ,
"type" : "string"
}
}
},
"rights" : {
"description" : "Rights granted or denied for this ACL entry" ,
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"READ" ,
"READ_EA" ,
"READ_ATTR" ,
"READ_ACL" ,
"WRITE_EA" ,
"WRITE_ATTR" ,
"WRITE_ACL" ,
"CHANGE_OWNER" ,
"WRITE_GROUP" ,
"DELETE" ,
"EXECUTE" ,
"MODIFY" ,
"EXTEND" ,
"ADD_FILE" ,
"ADD_SUBDIR" ,
"DELETE_CHILD" ,
"SYNCHRONIZE" ,
"ALL"
],
"description" : "Rights granted or denied for this ACL entry: \n * `ADD_FILE` - API_FILES_ACCESS_ADD_FILE, \n * `ADD_SUBDIR` - API_FILES_ACCESS_ADD_SUBDIR, \n * `ALL` - API_FILES_ACCESS_ALL, \n * `CHANGE_OWNER` - API_FILES_ACCESS_CHANGE_OWNER, \n * `DELETE` - API_FILES_ACCESS_DELETE, \n * `DELETE_CHILD` - API_FILES_ACCESS_DELETE_CHILD, \n * `EXECUTE` - API_FILES_ACCESS_EXECUTE, \n * `EXTEND` - API_FILES_ACCESS_EXTEND, \n * `MODIFY` - API_FILES_ACCESS_MODIFY, \n * `READ` - API_FILES_ACCESS_READ, \n * `READ_ACL` - API_FILES_ACCESS_READ_ACL, \n * `READ_ATTR` - API_FILES_ACCESS_READ_ATTR, \n * `READ_EA` - API_FILES_ACCESS_READ_EA, \n * `SYNCHRONIZE` - API_FILES_ACCESS_SYNCHRONIZE, \n * `WRITE_ACL` - API_FILES_ACCESS_WRITE_ACL, \n * `WRITE_ATTR` - API_FILES_ACCESS_WRITE_ATTR, \n * `WRITE_EA` - API_FILES_ACCESS_WRITE_EA, \n * `WRITE_GROUP` - API_FILES_ACCESS_WRITE_GROUP"
}
}
}
}
}
}
} Response
Codes
Code
Description
200
Return value on success
Schema
{
"description" : "api_files_acl_v2" ,
"type" : "object" ,
"properties" : {
"control" : {
"description" : "control" ,
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"PRESENT" ,
"DEFAULTED" ,
"TRUSTED" ,
"AUTO_INHERIT" ,
"PROTECTED" ,
"ALL"
],
"description" : "control: \n * `ALL` - API_FILES_ACL_CONTROL_ALL, \n * `AUTO_INHERIT` - API_FILES_ACL_CONTROL_AUTO_INHERIT, \n * `DEFAULTED` - API_FILES_ACL_CONTROL_DEFAULTED, \n * `PRESENT` - API_FILES_ACL_CONTROL_PRESENT, \n * `PROTECTED` - API_FILES_ACL_CONTROL_PROTECTED, \n * `TRUSTED` - API_FILES_ACL_CONTROL_TRUSTED"
}
},
"posix_special_permissions" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"STICKY_BIT" ,
"SET_GID" ,
"SET_UID"
],
"description" : "posix_special_permissions: \n * `SET_GID` - SET_GID, \n * `SET_UID` - SET_UID, \n * `STICKY_BIT` - STICKY_BIT"
}
},
"aces" : {
"type" : "array" ,
"items" : {
"description" : "aces" ,
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string" ,
"enum" : [
"ALLOWED" ,
"DENIED"
],
"description" : "Type of this ACL entry: \n * `ALLOWED` - API_FILES_ACE_TYPE_ALLOWED, \n * `DENIED` - API_FILES_ACE_TYPE_DENIED"
},
"flags" : {
"description" : "ACE flags for this ACL entry" ,
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"OBJECT_INHERIT" ,
"CONTAINER_INHERIT" ,
"NO_PROPAGATE_INHERIT" ,
"INHERIT_ONLY" ,
"INHERITED" ,
"ALL"
],
"description" : "ACE flags for this ACL entry: \n * `ALL` - API_FILES_ACE_FLAG_ALL, \n * `CONTAINER_INHERIT` - API_FILES_ACE_FLAG_CONTAINER_INHERIT, \n * `INHERITED` - API_FILES_ACE_FLAG_INHERITED, \n * `INHERIT_ONLY` - API_FILES_ACE_FLAG_INHERIT_ONLY, \n * `NO_PROPAGATE_INHERIT` - API_FILES_ACE_FLAG_NO_PROPAGATE_INHERIT, \n * `OBJECT_INHERIT` - API_FILES_ACE_FLAG_OBJECT_INHERIT"
}
},
"trustee" : {
"description" : "Trustee for this ACL entry" ,
"type" : "object" ,
"properties" : {
"domain" : {
"type" : "string" ,
"enum" : [
"LOCAL" ,
"API_NULL_DOMAIN" ,
"WORLD" ,
"POSIX_USER" ,
"POSIX_GROUP" ,
"ACTIVE_DIRECTORY" ,
"API_INVALID_DOMAIN" ,
"API_RESERVED_DOMAIN" ,
"API_INTERNAL_DOMAIN" ,
"API_OPERATOR_DOMAIN" ,
"API_CREATOR_DOMAIN"
],
"description" : "domain: \n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY, \n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN, \n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN, \n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN, \n * `API_NULL_DOMAIN` - API_NULL_DOMAIN, \n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN, \n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN, \n * `LOCAL` - LOCAL, \n * `POSIX_GROUP` - POSIX_GROUP, \n * `POSIX_USER` - POSIX_USER, \n * `WORLD` - WORLD"
},
"auth_id" : {
"description" : "auth_id" ,
"type" : "string"
},
"uid" : {
"description" : "uid" ,
"type" : "number"
},
"gid" : {
"description" : "gid" ,
"type" : "number"
},
"sid" : {
"description" : "sid" ,
"type" : "string"
},
"name" : {
"description" : "name" ,
"type" : "string"
}
}
},
"rights" : {
"description" : "Rights granted or denied for this ACL entry" ,
"type" : "array" ,
"items" : {
"type" : "string" ,
"enum" : [
"READ" ,
"READ_EA" ,
"READ_ATTR" ,
"READ_ACL" ,
"WRITE_EA" ,
"WRITE_ATTR" ,
"WRITE_ACL" ,
"CHANGE_OWNER" ,
"WRITE_GROUP" ,
"DELETE" ,
"EXECUTE" ,
"MODIFY" ,
"EXTEND" ,
"ADD_FILE" ,
"ADD_SUBDIR" ,
"DELETE_CHILD" ,
"SYNCHRONIZE" ,
"ALL"
],
"description" : "Rights granted or denied for this ACL entry: \n * `ADD_FILE` - API_FILES_ACCESS_ADD_FILE, \n * `ADD_SUBDIR` - API_FILES_ACCESS_ADD_SUBDIR, \n * `ALL` - API_FILES_ACCESS_ALL, \n * `CHANGE_OWNER` - API_FILES_ACCESS_CHANGE_OWNER, \n * `DELETE` - API_FILES_ACCESS_DELETE, \n * `DELETE_CHILD` - API_FILES_ACCESS_DELETE_CHILD, \n * `EXECUTE` - API_FILES_ACCESS_EXECUTE, \n * `EXTEND` - API_FILES_ACCESS_EXTEND, \n * `MODIFY` - API_FILES_ACCESS_MODIFY, \n * `READ` - API_FILES_ACCESS_READ, \n * `READ_ACL` - API_FILES_ACCESS_READ_ACL, \n * `READ_ATTR` - API_FILES_ACCESS_READ_ATTR, \n * `READ_EA` - API_FILES_ACCESS_READ_EA, \n * `SYNCHRONIZE` - API_FILES_ACCESS_SYNCHRONIZE, \n * `WRITE_ACL` - API_FILES_ACCESS_WRITE_ACL, \n * `WRITE_ATTR` - API_FILES_ACCESS_WRITE_ATTR, \n * `WRITE_EA` - API_FILES_ACCESS_WRITE_EA, \n * `WRITE_GROUP` - API_FILES_ACCESS_WRITE_GROUP"
}
}
}
}
}
}
}
