Skip to content
View as Markdown
View as Markdown

@salesforce/b2c-tooling-sdk / auth / OAuthAuthConfig

Interface: OAuthAuthConfig

Defined in: packages/b2c-tooling-sdk/src/auth/types.ts:105

Configuration for OAuth authentication. Used for OCAPI and platform API operations.

Properties

accountManagerHost?

optional accountManagerHost: string

Defined in: packages/b2c-tooling-sdk/src/auth/types.ts:109


clientId

clientId: string

Defined in: packages/b2c-tooling-sdk/src/auth/types.ts:106


clientSecret?

optional clientSecret: string

Defined in: packages/b2c-tooling-sdk/src/auth/types.ts:107


jwtCertPath?

optional jwtCertPath: string

Defined in: packages/b2c-tooling-sdk/src/auth/types.ts:111

Path to JWT certificate file (cert.pem) for the JWT Bearer flow


jwtKeyPath?

optional jwtKeyPath: string

Defined in: packages/b2c-tooling-sdk/src/auth/types.ts:113

Path to JWT private key file (key.pem) for the JWT Bearer flow


jwtPassphrase?

optional jwtPassphrase: string

Defined in: packages/b2c-tooling-sdk/src/auth/types.ts:115

Optional passphrase for an encrypted JWT private key


openBrowser()?

optional openBrowser: (url) => Promise<void>

Defined in: packages/b2c-tooling-sdk/src/auth/types.ts:119

Custom browser opener for browser OAuth flows. Receives the authorization URL.

Parameters

url

string

Returns

Promise<void>


redirectUri?

optional redirectUri: string

Defined in: packages/b2c-tooling-sdk/src/auth/types.ts:117

Override redirect URI for browser OAuth flows (e.g., for port forwarding in remote environments)


scopes?

optional scopes: string[]

Defined in: packages/b2c-tooling-sdk/src/auth/types.ts:108

Released under the Apache-2.0 License.