Skip to content

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

Interface: ImplicitOAuthConfig ​

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-implicit.ts:25

Configuration for the implicit OAuth flow.

Properties ​

accountManagerHost? ​

optional accountManagerHost: string

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-implicit.ts:31

Account Manager host (defaults to 'account.demandware.com')


clientId ​

clientId: string

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-implicit.ts:27

OAuth client ID registered with Account Manager


localPort? ​

optional localPort: number

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-implicit.ts:36

Local port for the OAuth redirect server. Defaults to 8080 or SFCC_OAUTH_LOCAL_PORT environment variable.


openBrowser()? ​

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

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-implicit.ts:49

Custom browser opener. Receives the authorization URL and should open it in the user's browser. Useful in environments where the default open package doesn't work (e.g., VS Code remote/Codespaces where vscode.env.openExternal is needed).

Parameters ​

url ​

string

Returns ​

Promise<void>


redirectUri? ​

optional redirectUri: string

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-implicit.ts:43

Full redirect URI for OAuth. Use when running behind a proxy where localhost cannot be reached directly by the browser. Defaults to http://localhost:${localPort} or SFCC_REDIRECT_URI environment variable. The local server still listens on localPort regardless of this setting.


scopes? ​

optional scopes: string[]

Defined in: packages/b2c-tooling-sdk/src/auth/oauth-implicit.ts:29

OAuth scopes to request (e.g., 'sfcc.products', 'sfcc.orders')

Released under the Apache-2.0 License.