Interface ElasticSecurityNodeParameters

Source
interface ElasticSecurityNodeParameters {
    additionalFields?:
        | {
            description?: string;
            owner?: string;
            syncAlerts?: boolean;
        }
        | { owner?: string };
    apiKeyId?: string;
    apiKeySecret?: string;
    apiToken?: string;
    apiUrl?: string;
    caseId?: string;
    category?: string;
    comment?: string;
    commentId?: string;
    connectorId?: string;
    connectorType?: ".resilient" | ".jira" | ".servicenow";
    email?: string;
    filters?: {
        status?: "open" | "closed" | "in-progress";
        tags?: unknown[];
    };
    impact?: 1
    | 3
    | 2;
    issueType?: string;
    issueTypes?: string;
    limit?: number;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "add"
        | "remove"
        | "delete"
        | "getStatus";
    orgId?: string;
    password?: string;
    priority?: string;
    projectKey?: string;
    resource?: | "case"
    | "caseComment"
    | "caseTag"
    | "connector";
    returnAll?: boolean;
    severity?: 1
    | 3
    | 2;
    severityCode?: number;
    simple?: boolean;
    sortOptions?: {
        sortOptionsProperties: {
            sortField?: "createdAt" | "updatedAt";
            sortOrder?: "asc" | "desc";
        };
    };
    tag?: string;
    title?: string;
    updateFields?: {
        description?: string;
        status?: "open"
        | "closed"
        | "in-progress";
        syncAlerts?: boolean;
        title?: string;
        version?: string;
    };
    urgency?: 1
    | 3
    | 2;
    username?: string;
}

Properties§

§readonly additionalFields?:
    | {
        description?: string;
        owner?: string;
        syncAlerts?: boolean;
    }
    | { owner?: string }

Default: {}

§readonly apiKeyId?: string

IBM Resilient API key ID Type options: {"password":true}

§readonly apiKeySecret?: string

IBM Resilient API key secret Type options: {"password":true}

§readonly apiToken?: string

Jira API token Type options: {"password":true}

§readonly apiUrl?: string

URL of the third-party instance

§readonly caseId?: string
§readonly category?: string

Category of the ServiceNow ITSM issue to create for this case

§readonly comment?: string
§readonly commentId?: string

ID of the case comment to retrieve

§readonly connectorId?: string

Connectors allow you to send Elastic Security cases into other systems (only ServiceNow, Jira, or IBM Resilient). Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getConnectors"}

§readonly connectorType?: ".resilient" | ".jira" | ".servicenow"

Default: ".jira"

§readonly email?: string

Jira-registered email

§readonly filters?: { ... }

Default: {}

§readonly impact?: 1 | 3 | 2

Impact of the ServiceNow ITSM issue to create for this case Default: 1

§readonly issueType?: string

Type of the Jira issue to create for this case

§readonly issueTypes?: string

Comma-separated list of numerical types of the IBM Resilient issue to create for this case

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

§readonly name?: string

Connectors allow you to send Elastic Security cases into other systems (only ServiceNow, Jira, or IBM Resilient)

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "getStatus"

Default: "create"

§readonly orgId?: string

IBM Resilient organization ID

§readonly password?: string

ServiceNow ITSM password Type options: {"password":true}

§readonly priority?: string

Priority of the Jira issue to create for this case

§readonly projectKey?: string

Jira Project Key

§readonly resource?: "case" | "caseComment" | "caseTag" | "connector"

Default: "case"

§readonly returnAll?: boolean

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

§readonly severity?: 1 | 3 | 2

Severity of the ServiceNow ITSM issue to create for this case Default: 1

§readonly severityCode?: number

Severity code of the IBM Resilient issue to create for this case Default: 1 Type options: {"minValue":0}

§readonly simple?: boolean

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

§readonly sortOptions?: { ... }

Default: {}

§readonly tag?: string

Tag to attach to the case. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getTags"}

§readonly title?: string
§readonly updateFields?: { ... }

Default: {}

§readonly urgency?: 1 | 3 | 2

Urgency of the ServiceNow ITSM issue to create for this case Default: 1

§readonly username?: string

ServiceNow ITSM username