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

Interface: AuthCredentials

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

Configuration for resolving an auth strategy. Combines all possible credential types.

Properties

accountManagerHost?

optional accountManagerHost: string

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

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

apiKey?

optional apiKey: string

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

API key for api-key auth

apiKeyHeaderName?

optional apiKeyHeaderName: string

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

Header name for API key (defaults to Authorization with Bearer prefix)

clientId?

optional clientId: string

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

OAuth client ID

clientSecret?

optional clientSecret: string

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

OAuth client secret (for client-credentials flow)

openBrowser()?

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

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

Custom browser opener for implicit OAuth flow. Receives the authorization URL.

Parameters

url

string

Returns

Promise<void>

password?

optional password: string

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

Password/access key for basic auth

redirectUri?

optional redirectUri: string

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

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

scopes?

optional scopes: string[]

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

OAuth scopes to request

username?

optional username: string

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

Username for basic auth