# 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

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: filesystem_acl

#### filesystem_acl

Type: object

ACLTemplateByPathArgs parameters.

No Additional Properties

##

#### Path

Type: string Default: ""

##

#### Query-Filters

Type: array Default: []
No Additional Items

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

Type: object

##

#### 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

Type: boolean Default: true

##

#### Extend

Default: null

## Any of

Type: string
Type: null

##

#### Extend Context

Default: null

## Any of

Type: string
Type: null

##

#### Prefix

Default: null

## Any of

Type: string
Type: null

##

#### Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated
query method.

##

#### Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may
also have one of more of the following special prefixes: `-` (reverse sort direction), `nulls_first:` (place
any null values at the head of the results list), `nulls_last:` (place any null values at the tail of the
results list).

No Additional Items

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

Type: string
Example:

    [
        "size",
        "-devname",
        "nulls_first:-expiretime"
    ]

##

#### Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character `.`
may be used to explicitly select only subkeys of the query result.

No Additional Items

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

## Any of

Type: string
Type: array
No Additional Items

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

Type: object
Example:

    [
        "username",
        "Authentication.status"
    ]

##

#### Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified `query-filters`.

##

#### Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified `query-filters`. The query fails
if there specified `query-filters` return no results.

##

#### Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the `limit` query-option
it may be used to implement pagination of large results arrays. WARNING: some query methods provide
volatile results and the onus is on the developer to understand whether pagination is appropriate
for a particular query API method.

##

#### Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified `query-filters` to return. When
combined wtih the `offset` query-option it may be used to implement pagination of large results arrays.
WARNING: some query methods provide volatile results and the onus is on the developer to understand whether
pagination is appropriate for a particular query API method.

##

#### Force Sql Filters

Type: boolean Default: false

##

#### AclTemplateFormatOptions

Type: object
Default:
{ "canonicalize": false, "ensure_builtins": false, "resolve_names": false }
No Additional Properties

##

#### Canonicalize

Type: boolean Default: false

##

#### Ensure Builtins

Type: boolean Default: false

##

#### Resolve Names

Type: boolean Default: false

##

#### Result

Type: array of object
No Additional Items

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

#### ACLTemplateEntry

Type: object
No Additional Properties

##

#### Id

Type: integer

##

#### Builtin

Type: boolean

##

#### Name

Type: string

##

#### Acltype

Type: enum (of string)

##### Must be one of:

- "NFS4"
- "POSIX1E"

##

#### Acl

## Any of

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
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

##

#### Comment

Type: string Default: ""

Required roles: FILESYSTEM_ATTRS_READ