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


NFS4ACLResult

Type: object
No Additional Properties

Path

Type: string

Must be at least 1 characters long

User


Type: string

Must be at least 1 characters long

Type: null

Group


Type: string

Must be at least 1 characters long

Type: null

Uid


Type: integer

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

Type: null

Gid


Type: integer

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

Type: null

Acltype

Type: const
Must be one of:
  • "NFS4"
Specific value: "NFS4"

Acl

Type: array
No Additional Items
Each item of this array must be:
Type: object

Type: object

Trivial

Type: boolean

POSIXACLResult

Type: object
No Additional Properties

Path

Type: string

Must be at least 1 characters long

User


Type: string

Must be at least 1 characters long

Type: null

Group


Type: string

Must be at least 1 characters long

Type: null

Uid


Type: integer

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

Type: null

Gid


Type: integer

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

Type: null

Acltype

Type: const
Must be one of:
  • "POSIX1E"
Specific value: "POSIX1E"

Acl

Type: array
No Additional Items
Each item of this array must be:
Type: object

Trivial

Type: boolean

DISABLED_ACLResult

Type: object
No Additional Properties

Path

Type: string

Must be at least 1 characters long

User


Type: string

Must be at least 1 characters long

Type: null

Group


Type: string

Must be at least 1 characters long

Type: null

Uid


Type: integer

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

Type: null

Gid


Type: integer

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

Type: null

Acltype

Type: const
Must be one of:
  • "DISABLED"
Specific value: "DISABLED"

Acl

Type: const
Must be one of:
  • null
Specific value: { "description": "😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️" }

Trivial

Type: const
Must be one of:
  • true
Specific value: true


Required roles: FILESYSTEM_ATTRS_READ