@hcl-software/domino-rest-sdk-node
    Preparing search index...

    Type Alias ScopeBody

    ScopeBody: {
        apiName: string;
        description?: string;
        icon?: string;
        iconName?: string;
        isActive?: boolean;
        maximumAccessLevel?: string;
        nsfPath: string;
        schemaName: string;
        server?: string;
    } & DominoBaseScope

    Domino REST API scope body.

    Type declaration

    • apiName: string

      Name that is used in dataSource parameter to access mapped resource.

    • Optionaldescription?: string

      Explanation of the scope.

    • Optionalicon?: string

      Base64 encoded icon (preferably SVG).

    • OptionaliconName?: string

      Alternate text for icon.

    • OptionalisActive?: boolean

      Allows to enable/disable API access without removing configuration.

    • OptionalmaximumAccessLevel?: string

      Limits, but not extends the access level granted to an API user. Mirrors the MaximumInternetAccess in DB ACLs. Default if not provided is Editor.

    • nsfPath: string

      Path relative to Domino data directory to NSF database.

    • schemaName: string

      Name (without .json extension) of schema file in NSF REST file resources.

    • Optionalserver?: string

      Domino server name that this scope is enabled on. Empty or '*' mean that this scope is enabled on all Domino servers.

    Settings

    Member Visibility