# filesystem.getacl

Return ACL of a given path. This may return a POSIX1e ACL or a NFSv4 ACL. The acl type is indicated by the acltype key.

simplified - effect of this depends on ACL type on underlying filesystem. In the case of NFSv4 ACLs simplified permissions and flags are returned for ACL entries where applicable. NFSv4 errata below. In the case of POSIX1E ACls, this setting has no impact on returned ACL.

resolve_ids - adds additional who key to each ACL entry, that converts the numeric id to a user name or group name. In the case of owner@ and group@ (NFSv4) or USER_OBJ and GROUP_OBJ (POSIX1E), st_uid or st_gid will be converted from stat() return for file. In the case of MASK (POSIX1E), OTHER (POSIX1E), everyone@ (NFSv4), key who will be included, but set to null. In case of failure to resolve the id to a name, who will be set to null. This option should only be used if resolving ids to names is required.

Errata about ACLType NFSv4:

simplified returns a shortened form of the ACL permset and flags where applicable. If permissions have been simplified, then the perms object will contain only a single BASIC key with a string describing the underlying permissions set.

TRAVERSE sufficient rights to traverse a directory, but not read contents.

READ sufficient rights to traverse a directory, and read file contents.

MODIFIY sufficient rights to traverse, read, write, and modify a file.

FULL_CONTROL all permissions.

If the permisssions do not fit within one of the pre-defined simplified permissions types, then the full ACL entry will be returned.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: path

#### path

Type: string

Must be at least `1` characters long

##### Parameter 2: simplified

#### simplified

Type: boolean Default: true

##### Parameter 3: resolve_ids

#### resolve_ids

Type: boolean Default: false

##

#### Result

## Any of

#### NFS4ACLResult

Type: object
No Additional Properties

##

#### Path

Type: string

Must be at least `1` characters long

##

#### User

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Group

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Uid

## Any of

Type: integer

Value must be greater or equal to `-1` and lesser or equal to `2147483647`

Type: null

##

#### Gid

## Any of

Type: integer

Value must be greater or equal to `-1` and lesser or equal to `2147483647`

Type: null

##

#### Acltype

Type: const
Specific value: `"NFS4"`

##

#### Acl

Type: array of object
No Additional Items

##### Each item of this array must be:

#### NFS4ACE

Type: object
No Additional Properties

##

#### Tag

Type: enum (of string)

##### Must be one of:

- "owner@"
- "group@"
- "everyone@"
- "USER"
- "GROUP"

##

#### Type

Type: enum (of string)

##### Must be one of:

- "ALLOW"
- "DENY"

##

#### Perms

## Any of

#### NFS4ACE_AdvancedPerms

Type: object
No Additional Properties

##

#### Read Data

Type: boolean Default: false

##

#### Write Data

Type: boolean Default: false

##

#### Append Data

Type: boolean Default: false

##

#### Read Named Attrs

Type: boolean Default: false

##

#### Write Named Attrs

Type: boolean Default: false

##

#### Execute

Type: boolean Default: false

##

#### Delete

Type: boolean Default: false

##

#### Delete Child

Type: boolean Default: false

##

#### Read Attributes

Type: boolean Default: false

##

#### Write Attributes

Type: boolean Default: false

##

#### Read Acl

Type: boolean Default: false

##

#### Write Acl

Type: boolean Default: false

##

#### Write Owner

Type: boolean Default: false

##

#### Synchronize

Type: boolean Default: false

#### NFS4ACE_BasicPerms

Type: object
No Additional Properties

##

#### Basic

Type: enum (of string)

##### Must be one of:

- "FULL_CONTROL"
- "MODIFY"
- "READ"
- "TRAVERSE"

##

#### Flags

## Any of

#### NFS4ACE_AdvancedFlags

Type: object
No Additional Properties

##

#### File Inherit

Type: boolean Default: false

##

#### Directory Inherit

Type: boolean Default: false

##

#### No Propagate Inherit

Type: boolean Default: false

##

#### Inherit Only

Type: boolean Default: false

##

#### Inherited

Type: boolean Default: false

#### NFS4ACE_BasicFlags

Type: object
No Additional Properties

##

#### Basic

Type: enum (of string)

##### Must be one of:

- "INHERIT"
- "NOINHERIT"

##

#### Id

Default: null

## Any of

Type: integer

Value must be greater or equal to `-1` and lesser or equal to `2147483647`

Type: null

##

#### Who

Default: null

## Any of

Type: string
Type: string

Must be at least `1` characters long

Type: null

##

#### NFS4ACL_Flags

Type: object
No Additional Properties

##

#### Autoinherit

Type: boolean Default: false

##

#### Protected

Type: boolean Default: false

##

#### Defaulted

Type: boolean Default: false

##

#### Trivial

Type: boolean

#### POSIXACLResult

Type: object
No Additional Properties

##

#### Path

Type: string

Must be at least `1` characters long

##

#### User

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Group

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Uid

## Any of

Type: integer

Value must be greater or equal to `-1` and lesser or equal to `2147483647`

Type: null

##

#### Gid

## Any of

Type: integer

Value must be greater or equal to `-1` and lesser or equal to `2147483647`

Type: null

##

#### Acltype

Type: const
Specific value: `"POSIX1E"`

##

#### Acl

Type: array of object
No Additional Items

##### Each item of this array must be:

#### POSIXACE

Type: object
No Additional Properties

##

#### Tag

Type: enum (of string)

##### Must be one of:

- "USER_OBJ"
- "GROUP_OBJ"
- "OTHER"
- "MASK"
- "USER"
- "GROUP"

##

#### POSIXACE_Perms

Type: object
No Additional Properties

##

#### Read

Type: boolean

##

#### Write

Type: boolean

##

#### Execute

Type: boolean

##

#### Default

Type: boolean

##

#### Id

Default: null

## Any of

Type: integer

Value must be greater or equal to `-1` and lesser or equal to `2147483647`

Type: null

##

#### Who

Default: null

## Any of

Type: string
Type: string

Must be at least `1` characters long

Type: null

##

#### Trivial

Type: boolean

#### DISABLED_ACLResult

Type: object
No Additional Properties

##

#### Path

Type: string

Must be at least `1` characters long

##

#### User

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Group

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Uid

## Any of

Type: integer

Value must be greater or equal to `-1` and lesser or equal to `2147483647`

Type: null

##

#### Gid

## Any of

Type: integer

Value must be greater or equal to `-1` and lesser or equal to `2147483647`

Type: null

##

#### Acltype

Type: const
Specific value: `"DISABLED"`

##

#### Acl

Type: null

##

#### Trivial

Type: const
Specific value: `true`

Required roles: FILESYSTEM_ATTRS_READ