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

Call parameters

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

Return value

Result

Any of

• NFS4ACLResult
• POSIXACLResult
• DISABLED_ACLResult

NFS4ACLResult

Type: object
No Additional Properties

path Required

Path

Type: string

Must be at least 1 characters long

user Required

User

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

group Required

Group

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

uid Required

Uid

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

gid Required

Gid

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

acltype Required

Acltype

Type: const

Must be one of:

• "NFS4"

Specific value: "NFS4"

acl Required

Acl

Type: array of object
No Additional Items

Each item of this array must be:

NFS4ACE

Type: object
No Additional Properties

tag Required

Tag

Type: enum (of string)

Must be one of:

• "owner@"
• "group@"
• "everyone@"
• "USER"
• "GROUP"

type Required

Type

Type: enum (of string)

Must be one of:

• "ALLOW"
• "DENY"

perms Required

Perms

Any of

• NFS4ACE_AdvancedPerms
• NFS4ACE_BasicPerms

NFS4ACE_AdvancedPerms

Type: object
No Additional Properties

READ_DATA

Read Data

Type: boolean Default: false

WRITE_DATA

Write Data

Type: boolean Default: false

APPEND_DATA

Append Data

Type: boolean Default: false

READ_NAMED_ATTRS

Read Named Attrs

Type: boolean Default: false

WRITE_NAMED_ATTRS

Write Named Attrs

Type: boolean Default: false

EXECUTE

Execute

Type: boolean Default: false

DELETE

Delete

Type: boolean Default: false

DELETE_CHILD

Delete Child

Type: boolean Default: false

READ_ATTRIBUTES

Read Attributes

Type: boolean Default: false

WRITE_ATTRIBUTES

Write Attributes

Type: boolean Default: false

READ_ACL

Read Acl

Type: boolean Default: false

WRITE_ACL

Write Acl

Type: boolean Default: false

WRITE_OWNER

Write Owner

Type: boolean Default: false

SYNCHRONIZE

Synchronize

Type: boolean Default: false

NFS4ACE_BasicPerms

Type: object
No Additional Properties

BASIC Required

Basic

Type: enum (of string)

Must be one of:

• "FULL_CONTROL"
• "MODIFY"
• "READ"
• "TRAVERSE"

flags Required

Flags

Any of

• NFS4ACE_AdvancedFlags
• NFS4ACE_BasicFlags

NFS4ACE_AdvancedFlags

Type: object
No Additional Properties

FILE_INHERIT

File Inherit

Type: boolean Default: false

DIRECTORY_INHERIT

Directory Inherit

Type: boolean Default: false

NO_PROPAGATE_INHERIT

No Propagate Inherit

Type: boolean Default: false

INHERIT_ONLY

Inherit Only

Type: boolean Default: false

INHERITED

Inherited

Type: boolean Default: false

NFS4ACE_BasicFlags

Type: object
No Additional Properties

BASIC Required

Basic

Type: enum (of string)

Must be one of:

• "INHERIT"
• "NOINHERIT"

id

Id

Default: null

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

who

Who

Default: null

Any of

• Option 1
• Option 2
• Option 3

Type: string

Type: string

Must be at least 1 characters long

Type: null

aclflags Required

NFS4ACL_Flags

Type: object
No Additional Properties

autoinherit

Autoinherit

Type: boolean Default: false

protected

Protected

Type: boolean Default: false

defaulted

Defaulted

Type: boolean Default: false

trivial Required

Trivial

Type: boolean

POSIXACLResult

Type: object
No Additional Properties

path Required

Path

Type: string

Must be at least 1 characters long

user Required

User

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

group Required

Group

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

uid Required

Uid

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

gid Required

Gid

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

acltype Required

Acltype

Type: const

Must be one of:

• "POSIX1E"

Specific value: "POSIX1E"

acl Required

Acl

Type: array of object
No Additional Items

Each item of this array must be:

POSIXACE

Type: object
No Additional Properties

tag Required

Tag

Type: enum (of string)

Must be one of:

• "USER_OBJ"
• "GROUP_OBJ"
• "OTHER"
• "MASK"
• "USER"
• "GROUP"

perms Required

POSIXACE_Perms

Type: object
No Additional Properties

READ Required

Read

Type: boolean

WRITE Required

Write

Type: boolean

EXECUTE Required

Execute

Type: boolean

default Required

Default

Type: boolean

id

Id

Default: null

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

who

Who

Default: null

Any of

• Option 1
• Option 2
• Option 3

Type: string

Type: string

Must be at least 1 characters long

Type: null

trivial Required

Trivial

Type: boolean

DISABLED_ACLResult

Type: object
No Additional Properties

path Required

Path

Type: string

Must be at least 1 characters long

user Required

User

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

group Required

Group

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

uid Required

Uid

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

gid Required

Gid

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

acltype Required

Acltype

Type: const

Must be one of:

• "DISABLED"

Specific value: "DISABLED"

acl Required

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 Required

Trivial

Type: const

Must be one of:

• true

Specific value: true

Required roles: FILESYSTEM_ATTRS_READ