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

    Interface Role

    interface Role {
        $id?: string | number | ExplicitKey<string>;
        $override?: Record<string, string | number | boolean>;
        assignable_by?: string;
        assignableBy?: string;
        can_delegate?: boolean;
        canDelegate?: boolean;
        contains_roles?: (string | Role)[];
        containsRoles?: (string | Role)[];
        description?: string;
        elevated_privilege?: boolean;
        elevatedPrivilege?: boolean;
        grantable?: boolean;
        name: string;
        protectionPolicy?: "read" | "protected";
        scoped_admin?: boolean;
        scopedAdmin?: boolean;
    }
    Index

    Properties

    $id? $override? assignable_by? assignableBy? can_delegate? canDelegate? contains_roles? containsRoles? description? elevated_privilege? elevatedPrivilege? grantable? name protectionPolicy? scoped_admin? scopedAdmin?

    Properties

    $id?: string | number | ExplicitKey<string>

    Role IDs are now derived from Role.name. The explicit $id is no longer used.

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

    Set properties not directly supported by this API.

    assignable_by?: string

    Other roles that can assign this role to users.

    assignableBy?: string

    Other roles that can assign this role to users.

    can_delegate?: boolean

    Indicates if the role can be delegated to other users.

    canDelegate?: boolean

    Indicates if the role can be delegated to other users.

    contains_roles?: (string | Role)[]

    Other roles that this role contains.

    containsRoles?: (string | Role)[]

    Other roles that this role contains.

    description?: string

    A description of what the role can access.

    elevated_privilege?: boolean

    Indicates whether manually accepting the responsibility of using the role before accessing its features is required.

    elevatedPrivilege?: boolean

    Indicates whether manually accepting the responsibility of using the role before accessing its features is required.

    grantable?: boolean

    Indicates whether the role can be granted independently.

    name: string

    Name for the role beginning with the application scope in the format: <scope>.<name>.

    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.
    scoped_admin?: boolean

    Indicates whether the role is an Application Administrator role.

    scopedAdmin?: boolean

    Indicates whether the role is an Application Administrator role.

    Settings

    Member Visibility

    On This Page

    Properties