planning-center-monorepo v1.0.0

planning-center-monorepo / planning-center-people-ts/src / OAuthAuth

Interface: OAuthAuth

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:13

Authentication configuration for OAuth 2.0 with required refresh handling

Properties

type

type: "oauth"

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:14

accessToken

accessToken: string

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:15

refreshToken

refreshToken: string

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:16

onRefresh()

onRefresh: (tokens) => void | Promise<void>

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:17

Parameters

tokens

accessToken

string

refreshToken

string

Returns

void | Promise<void>

onRefreshFailure()

onRefreshFailure: (error) => void | Promise<void>

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:21

Parameters

error

Error

Returns

void | Promise<void>

clientId?

optional clientId: string

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:23

Client ID for token refresh (optional, can use environment variable PCO_APP_ID)

clientSecret?

optional clientSecret: string

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:25

Client Secret for token refresh (optional, can use environment variable PCO_APP_SECRET)