Skip to content
View as Markdown
View as Markdown

@salesforce/b2c-tooling-sdk / config / ResolvedB2CConfig

Interface: ResolvedB2CConfig

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:412

Properties

sources

readonly sources: ConfigSourceInfo[]

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:420

Information about which sources contributed to the config


values

readonly values: NormalizedConfig

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:414

Raw configuration values


warnings

readonly warnings: ConfigWarning[]

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:417

Warnings generated during resolution

Methods

createB2CInstance()

createB2CInstance(options?): B2CInstance

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:455

Creates a B2CInstance from the resolved configuration.

Parameters

options?

Pick<CreateOAuthOptions, "redirectUri" | "openBrowser">

Options for implicit OAuth (redirectUri, openBrowser)

Returns

B2CInstance

Throws

Error if hostname is not configured


createBasicAuth()

createBasicAuth(): AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:461

Creates a Basic auth strategy.

Returns

AuthStrategy

Throws

Error if username or password is not configured


createMrtAuth()

createMrtAuth(): AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:474

Creates an MRT auth strategy (API key).

Returns

AuthStrategy

Throws

Error if mrtApiKey is not configured


createOAuth()

createOAuth(options?): AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:468

Creates an OAuth auth strategy.

Parameters

options?

CreateOAuthOptions

OAuth options (allowed methods)

Returns

AuthStrategy

Throws

Error if clientId is not configured


createWebDavAuth()

createWebDavAuth(): AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:481

Creates a WebDAV auth strategy. Prefers Basic auth if available, falls back to OAuth.

Returns

AuthStrategy

Throws

Error if neither Basic auth nor OAuth is configured


hasB2CInstanceConfig()

hasB2CInstanceConfig(): boolean

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:428

Check if B2C instance configuration is available. Requires: hostname

Returns

boolean


hasBasicAuthConfig()

hasBasicAuthConfig(): boolean

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:446

Check if Basic auth configuration is available. Requires: username and password

Returns

boolean


hasMrtConfig()

hasMrtConfig(): boolean

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:434

Check if MRT configuration is available. Requires: mrtApiKey

Returns

boolean


hasOAuthConfig()

hasOAuthConfig(): boolean

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:440

Check if OAuth configuration is available. Requires: clientId

Returns

boolean

Released under the Apache-2.0 License.