Interface: OAuthClientOptions

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

Options for constructing an OAuthClient.

Properties

clientId

clientId: string;

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

OAuth2 client ID.

---

clientSecret

clientSecret: string;

Defined in: src/management/oauth-client.ts:26

OAuth2 client secret.

---

tsgId

tsgId: string;

Defined in: src/management/oauth-client.ts:28

Tenant Service Group ID.

---

tokenEndpoint?

optional tokenEndpoint?: string;

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

OAuth2 token endpoint URL. Defaults to Palo Alto Networks auth endpoint.

---

tokenBufferMs?

optional tokenBufferMs?: number;

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

Pre-expiry buffer in ms. Token refreshes this many ms before expiry. Defaults to 30000 (30s).

---

onTokenRefresh?

optional onTokenRefresh?: (info) => void;

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

Callback invoked after each successful token refresh with current TokenInfo.

Parameters

Parameter	Type
info	TokenInfo

Returns

void