Interface IFieldAccessControlEntry

A single access control entry (ACE) on a template field definition: one trustee, whether its rights are allowed or denied, and the rights themselves. A trustee that has both allowed and denied rights is represented as two ACEs. Unlike entry ACEs, field ACEs have no scope and are never inherited.

interface IFieldAccessControlEntry {
    accessControlType?: AccessControlType;
    inheritedFrom?: string;
    isInherited?: boolean;
    rights?: FieldRight[];
    trustee?: TrusteeIdentity;
}

Implemented by

Properties

accessControlType? inheritedFrom? isInherited? rights? trustee?

Properties

OptionalaccessControlType

accessControlType?: AccessControlType

Whether the ACE grants (Allow) or denies (Deny) the listed rights. Required on input — a missing value is rejected (it must not silently default to Allow).

OptionalinheritedFrom

inheritedFrom?: string

When inherited, a description of where the ACE was inherited from. Output only; null for field ACEs.

OptionalisInherited

isInherited?: boolean

True when this ACE is inherited. Always false for field ACEs (field definitions have no ACL inheritance); returned for contract symmetry and ignored on input.

Optionalrights

rights?: FieldRight[]

The rights granted or denied by this ACE.

Optionaltrustee

trustee?: TrusteeIdentity

The trustee this ACE applies to. On input, identify the trustee by either trustee.sid or trustee.accountName (the SID takes precedence when both are given).

Settings

Member Visibility

On This Page

Properties