nodes/generated

Interface SecurityScorecardNodeParameters

Source
interface SecurityScorecardNodeParameters {
    additionalFields?: {
        days_to_resolve_issue?: number;
        domain?: string;
        grade_to_maintain?: string;
        is_organization_point_of_contact?: boolean;
        issue_desc?: string;
        issue_title?: string;
        issue_type?: string;
        sendme_copy?: boolean;
        target_url?: string;
    };
    binaryPropertyName?: string;
    branding?: | "company"
    | "securityscorecard"
    | "company_and_securityscorecard";
    date?: string;
    description?: string;
    domain?: string;
    email?: string;
    filters?: | { severity?: string; severity_in?: string }
    | {
        grade?: string;
        industry?: string;
        issueType?: string;
        status?: "active" | "inactive";
        vulnerability?: string;
    };
    firstName?: string;
    industry?: | "retail"
    | "food"
    | "healthcare"
    | "manofacturing"
    | "technology";
    lastName?: string;
    limit?: number;
    message?: string;
    name?: string;
    operation?: | "create"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "generate"
    | "download"
    | "getFactor"
    | "getFactorHistorical"
    | "getHistoricalScore"
    | "getScorecard"
    | "getScorePlan"
    | "getScore";
    options?: | {
        date_from?: string;
        date_to?: string;
        timing?: "daily"
        | "monthly"
        | "weekly";
    }
    | { from?: string; to?: string }
    | { format?: "pdf" | "csv" }
    | {
        countries?: string;
        format?: "pdf" | "csv";
        ips?: string;
        subdomains?: string;
    };
    portfolioId?: string;
    privacy?: "private"
    | "team"
    | "shared";
    report?:
        | "issues"
        | "summary"
        | "portfolio"
        | "detailed"
        | "events-json"
        | "partnership"
        | "full-scorecard-json"
        | "scorecard-footprint";
    resource?: | "company"
    | "industry"
    | "report"
    | "invite"
    | "portfolio"
    | "portfolioCompany";
    returnAll?: boolean;
    score?: number;
    scorecardIdentifier?: string;
    simple?: boolean;
    url?: string;
}

Properties§

Source§

readonly additionalFields?: {
    days_to_resolve_issue?: number;
    domain?: string;
    grade_to_maintain?: string;
    is_organization_point_of_contact?: boolean;
    issue_desc?: string;
    issue_title?: string;
    issue_type?: string;
    sendme_copy?: boolean;
    target_url?: string;
}

Default: {}

Source§

readonly binaryPropertyName?: string

Default: "data"

Source§

readonly branding?:
    | "company"
    | "securityscorecard"
    | "company_and_securityscorecard"

Default: "securityscorecard"

Source§

readonly date?: string

Source§

readonly description?: string

Source§

readonly domain?: string

Company's domain name

Source§

readonly email?: string

Source§

readonly filters?:
    | { severity?: string; severity_in?: string }
    | {
        grade?: string;
        industry?: string;
        issueType?: string;
        status?: "active" | "inactive";
        vulnerability?: string;
    }

Default: {}

Source§

readonly firstName?: string

Source§

readonly industry?:
    | "retail"
    | "food"
    | "healthcare"
    | "manofacturing"
    | "technology"

Default: "food"

Source§

readonly lastName?: string

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":100}

Source§

readonly message?: string

Message for the invitee

Source§

readonly name?: string

Name of the portfolio

Source§

readonly operation?:
    | "create"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "generate"
    | "download"
    | "getFactor"
    | "getFactorHistorical"
    | "getHistoricalScore"
    | "getScorecard"
    | "getScorePlan"
    | "getScore"

Default: "getFactor"

Source§

readonly options?:
    | {
        date_from?: string;
        date_to?: string;
        timing?: "daily"
        | "monthly"
        | "weekly";
    }
    | { from?: string; to?: string }
    | { format?: "pdf" | "csv" }
    | {
        countries?: string;
        format?: "pdf" | "csv";
        ips?: string;
        subdomains?: string;
    }

Default: {}

Source§

readonly portfolioId?: string

Source§

readonly privacy?: "private" | "team" | "shared"

Default: "shared"

Source§

readonly report?:
    | "issues"
    | "summary"
    | "portfolio"
    | "detailed"
    | "events-json"
    | "partnership"
    | "full-scorecard-json"
    | "scorecard-footprint"

Default: "detailed"

Source§

readonly resource?:
    | "company"
    | "industry"
    | "report"
    | "invite"
    | "portfolio"
    | "portfolioCompany"

Default: "company"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly score?: number

Score target

Source§

readonly scorecardIdentifier?: string

Primary identifier of a company or scorecard, i.e. domain.

Source§

readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

Source§

readonly url?: string

URL to a generated report