@servicenow/sdk - v4.7.0
    Preparing search index...

    Interface Acl<T, Type>

    interface Acl<T extends TableName, Type extends AclType = AclType> {
        $id: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" | "once" };
        $override?: Record<string, string | number | boolean>;
        active?: boolean;
        admin_overrides?: boolean;
        adminOverrides?: boolean;
        condition?: string;
        decision_type?: "allow" | "deny";
        decisionType?: "allow" | "deny";
        description?: string;
        local_or_existing?: "Local" | "Existing";
        localOrExisting?: "Local" | "Existing";
        operation:
            | string & {}
            | "read"
            | "delete"
            | "create"
            | "execute"
            | "write"
            | "conditional_table_query_range"
            | "data_fabric"
            | "query_match"
            | "query_range"
            | "edit_task_relations"
            | "edit_ci_relations"
            | "save_as_template"
            | "add_to_list"
            | "report_on"
            | "list_edit"
            | "report_view"
            | "personalize_choices";
        protectionPolicy?: "read"
        | "protected";
        roles?: (string | Role)[];
        script?: string | ((current: any, ...dependencies: any[]) => boolean);
        security_attribute?:
            | string & {}
            | "user_is_authenticated"
            | "has_admin_role"
            | Record<"sys_security_attribute">;
        securityAttribute?:
            | string & {}
            | "user_is_authenticated"
            | "has_admin_role"
            | Record<"sys_security_attribute">;
        type: Type;
    }

    Type Parameters

    Index

    Properties

    $id $meta? $override? active? admin_overrides? adminOverrides? condition? decision_type? decisionType? description? local_or_existing? localOrExisting? operation protectionPolicy? roles? script? security_attribute? securityAttribute? type

    Properties

    $id: string | number | ExplicitKey<string>
    $meta?: { installMethod?: "first install" | "demo" | "once" }

    Type Declaration

    • OptionalinstallMethod?: "first install" | "demo" | "once"

      Map a record to an output folder that loads only in specific circumstances. 'first install' -> 'unload' (only loaded when plugin is first registered), 'demo' -> 'unload.demo' (only loaded when demo data is loaded), 'once' -> 'apply_once' (scripts that are only applied once)

    $override?: Record<string, string | number | boolean>

    Set properties not directly supported by this API.

    active?: boolean

    Whether the ACL rule is enabled or not

    admin_overrides?: boolean

    Whether users with admin role automatically pass the permissions check for this ACL rule

    adminOverrides?: boolean

    Whether users with admin role automatically pass the permissions check for this ACL rule

    condition?: string

    Filter query specifying fields and values that must be true for access

    decision_type?: "allow" | "deny"

    Whether the ACL should allow or deny access

    decisionType?: "allow" | "deny"

    Whether the ACL should allow or deny access

    description?: string

    Description of the object or permissions this ACL rule secures

    local_or_existing?: "Local" | "Existing"

    Type of security attribute: 'Local' for condition-based or 'Existing' to reference an attribute

    localOrExisting?: "Local" | "Existing"

    Type of security attribute: 'Local' for condition-based or 'Existing' to reference an attribute

    operation:
        | string & {}
        | "read"
        | "delete"
        | "create"
        | "execute"
        | "write"
        | "conditional_table_query_range"
        | "data_fabric"
        | "query_match"
        | "query_range"
        | "edit_task_relations"
        | "edit_ci_relations"
        | "save_as_template"
        | "add_to_list"
        | "report_on"
        | "list_edit"
        | "report_view"
        | "personalize_choices"

    The operation this ACL rule secures

    protectionPolicy?: "read" | "protected"

    Controls edit/view access for other developers after the application is installed.

    • read: Others can see the script logic but not change it.
    • protected: Others cannot change this record.
    • Omit to allow other developers to customize this record.
    roles?: (string | Role)[]

    Array of roles that have access to the object

    script?: string | ((current: any, ...dependencies: any[]) => boolean)

    Script that defines the permissions required to access the object

    security_attribute?:
        | string & {}
        | "user_is_authenticated"
        | "has_admin_role"
        | Record<"sys_security_attribute">

    Pre-defined conditions or security attributes to use for access control

    securityAttribute?:
        | string & {}
        | "user_is_authenticated"
        | "has_admin_role"
        | Record<"sys_security_attribute">

    Pre-defined conditions or security attributes to use for access control

    type: Type

    Type of the resource being secured

    Settings

    Member Visibility

    On This Page

    Properties