Skip to main content

Interface: OAuthClientOptions

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

Options for constructing an OAuthClient.

Properties​

clientId​

clientId: string;

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

OAuth2 client ID.


clientSecret​

clientSecret: string;

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

OAuth2 client secret.


tsgId​

tsgId: string;

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

Tenant Service Group ID.


tokenEndpoint?​

optional tokenEndpoint?: string;

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

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


tokenBufferMs?​

optional tokenBufferMs?: number;

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

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:35

Callback invoked after each successful token refresh with current TokenInfo.

Parameters​

ParameterType
infoTokenInfo

Returns​

void