Skip to main content

Interface: ManagementClientOptions

Defined in: src/management/client.ts:16

Options for constructing a ManagementClient.

Properties

clientId?

optional clientId?: string;

Defined in: src/management/client.ts:18

OAuth2 client ID. Falls back to PANW_MGMT_CLIENT_ID env var.


clientSecret?

optional clientSecret?: string;

Defined in: src/management/client.ts:20

OAuth2 client secret. Falls back to PANW_MGMT_CLIENT_SECRET env var.


tsgId?

optional tsgId?: string;

Defined in: src/management/client.ts:22

Tenant Service Group ID. Falls back to PANW_MGMT_TSG_ID env var.


apiEndpoint?

optional apiEndpoint?: string;

Defined in: src/management/client.ts:24

Management API endpoint URL. Falls back to PANW_MGMT_ENDPOINT env var.


dlpEndpoint?

optional dlpEndpoint?: string;

Defined in: src/management/client.ts:30

DLP (Data Loss Prevention) API endpoint URL. Used by the dlp subclients. Defaults to https://api.dlp.paloaltonetworks.com. Constructor-only — no env var override (DLP shares OAuth credentials with the management API).


tokenEndpoint?

optional tokenEndpoint?: string;

Defined in: src/management/client.ts:32

OAuth2 token endpoint URL. Falls back to PANW_MGMT_TOKEN_ENDPOINT env var.


numRetries?

optional numRetries?: number;

Defined in: src/management/client.ts:34

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