filesystem.acltemplate.by_path

Retrieve list of available ACL templates for a given path.

Supports query-filters and query-options. format-options gives additional options to alter the results of the template query:

canonicalize - place ACL entries for NFSv4 ACLs in Microsoft canonical order. ensure_builtins - ensure all results contain entries for builtin_users and builtin_administrators groups. resolve_names - convert ids in ACL entries into names.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filesystem_acl

filesystem_acl

Type: object
No Additional Properties

path

Path

Type: string Default: ""

query-filters

Query-Filters

Type: array Default: []
No Additional Items

Each item of this array must be:

Type: object

query-options

QueryOptions

Type: object

Default:

{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

No Additional Properties

relationships

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extra

Extra

Type: object Default: {}

order_by

Order By

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

select

Select

Type: array Default: []
No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

count

Count

Type: boolean Default: false

get

Get

Type: boolean Default: false

offset

Offset

Type: integer Default: 0

limit

Limit

Type: integer Default: 0

force_sql_filters

Force Sql Filters

Type: boolean Default: false

format-options

AclTemplateFormatOptions

Type: object

Default:

{ "canonicalize": false, "ensure_builtins": false, "resolve_names": false }

No Additional Properties

canonicalize

Canonicalize

Type: boolean Default: false

ensure_builtins

Ensure Builtins

Type: boolean Default: false

resolve_names

Resolve Names

Type: boolean Default: false

Return value

Result

Type: array of object
No Additional Items

Each item of this array must be:

AclTemplateEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

builtin Required

Builtin

Type: boolean

name Required

Name

Type: string

acltype Required

Acltype

Type: enum (of string)

Must be one of:

• "NFS4"
• "POSIX1E"

acl Required

Acl

Any of

• Option 1
• Option 2

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

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

comment

Comment

Type: string Default: ""

Required roles: FILESYSTEM_ATTRS_READ