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

    Interface Acl<T>

    interface Acl<T extends TableName> {
        $id: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" };
        active?: boolean;
        admin_overrides?: boolean;
        adminOverrides?: boolean;
        condition?: string;
        decision_type?: "allow" | "deny";
        decisionType?: "allow" | "deny";
        description?: string;
        field?: SystemColumns | "*" | keyof FullSchema<T>;
        local_or_existing?: "Local" | "Existing";
        localOrExisting?: "Local" | "Existing";
        name?: string;
        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">;
        table?: T;
        type:
            | string & {}
            | "client_callable_flow_object"
            | "client_callable_script_include"
            | "processor"
            | "ui_page"
            | "graphql"
            | "rest_endpoint"
            | "ux_page"
            | "ux_route"
            | "pd_action"
            | "record"
            | "ux_data_broker";
    }

    Type Parameters

    Index

    Properties

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

    Properties

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

    Type Declaration

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

      Map a record to an output folder that loads only in specific circumstances. 'first install' - > 'unload', 'demo' -> 'unload.demo'

    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

    field?: SystemColumns | "*" | keyof FullSchema<T>

    Optional field within the table to secure, or '*' for all fields

    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

    name?: string

    Name of the resource being secured

    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

    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

    table?: T

    The table this ACL rule applies to

    type:
        | string & {}
        | "client_callable_flow_object"
        | "client_callable_script_include"
        | "processor"
        | "ui_page"
        | "graphql"
        | "rest_endpoint"
        | "ux_page"
        | "ux_route"
        | "pd_action"
        | "record"
        | "ux_data_broker"

    Type of the named resource being secured

    Settings

    Member Visibility

    On This Page

    Properties