Skip to main content

Interface: RedTeamClientOptions

Defined in: src/red-team/client.ts:50

Options for constructing a RedTeamClient.

Properties​

clientId?​

optional clientId?: string;

Defined in: src/red-team/client.ts:52

OAuth2 client ID. Falls back to PANW_RED_TEAM_CLIENT_ID, then PANW_MGMT_CLIENT_ID.

clientSecret?​

optional clientSecret?: string;

Defined in: src/red-team/client.ts:54

OAuth2 client secret. Falls back to PANW_RED_TEAM_CLIENT_SECRET, then PANW_MGMT_CLIENT_SECRET.

tsgId?​

optional tsgId?: string;

Defined in: src/red-team/client.ts:56

Tenant Service Group ID. Falls back to PANW_RED_TEAM_TSG_ID, then PANW_MGMT_TSG_ID.

dataEndpoint?​

optional dataEndpoint?: string;

Defined in: src/red-team/client.ts:58

Data plane endpoint URL. Falls back to PANW_RED_TEAM_DATA_ENDPOINT.

mgmtEndpoint?​

optional mgmtEndpoint?: string;

Defined in: src/red-team/client.ts:60

Management plane endpoint URL. Falls back to PANW_RED_TEAM_MGMT_ENDPOINT.

networkBrokerEndpoint?​

optional networkBrokerEndpoint?: string;

Defined in: src/red-team/client.ts:62

Network broker endpoint URL. Falls back to PANW_RED_TEAM_NETWORK_BROKER_ENDPOINT.

tokenEndpoint?​

optional tokenEndpoint?: string;

Defined in: src/red-team/client.ts:64

OAuth2 token endpoint URL. Falls back to PANW_RED_TEAM_TOKEN_ENDPOINT, then PANW_MGMT_TOKEN_ENDPOINT.

numRetries?​

optional numRetries?: number;

Defined in: src/red-team/client.ts:66

Max retry attempts (0-5). Defaults to 5.