@salesforce/b2c-tooling-sdk / config / CreateB2CInstanceOptions
Interface: CreateB2CInstanceOptions
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:536
Options for constructing a B2C instance from resolved configuration.
Extends
Pick<CreateOAuthOptions,"redirectUri"|"openBrowser">
Properties
defaultWebDavClient?
optionaldefaultWebDavClient:boolean
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:551
Let WebDAV fall back to a browser login with the built-in public client when neither Basic auth nor an API client is configured. The resulting user token is authorized by the user's Business Manager permissions, so no access key or WebDAV Client Permissions entry is needed. OCAPI and SCAPI are unaffected. Enable it only for WebDAV-only operations (file transfer, logs, code upload), since the login starts on the first WebDAV request.
oauthStrategy?
optionaloauthStrategy:AuthStrategy| () =>AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:542
Pre-resolved OAuth strategy, or a lazy factory for one. CLI command bases use the factory form to preserve stored PKCE sessions and avoid prompting unless an OAuth-backed client is actually used.
openBrowser()?
optionalopenBrowser: (url,login?) =>Promise<void>
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:532
Custom browser opener for browser OAuth flows. Receives the authorization URL and, for PKCE logins, a handle to the pending login.
Parameters
url
string
login?
Returns
Promise<void>
Inherited from
CreateOAuthOptions.openBrowser
redirectUri?
optionalredirectUri:string
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:530
Override redirect URI for browser OAuth flows (e.g., for port forwarding in remote environments)
Inherited from
CreateOAuthOptions.redirectUri
webdavFallbackStrategy?
optionalwebdavFallbackStrategy:AuthStrategy| () =>AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:557
WebDAV-only fallback strategy (or lazy factory). Takes precedence over defaultWebDavClient; used by callers that build their own browser login strategy.