Skip to content

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

Interface: DwJsonMultiConfig ​

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:127

dw.json with multi-config support (configs array).

Extends ​

Properties ​

accountManagerHost? ​

optional accountManagerHost: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:63

Account Manager hostname for OAuth

Inherited from ​

DwJsonConfig.accountManagerHost


active? ​

optional active: boolean

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:35

Whether this config is active (for multi-config files)

Inherited from ​

DwJsonConfig.active


authMethods? ​

optional authMethods: AuthMethod[]

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:61

Allowed authentication methods in priority order

Inherited from ​

DwJsonConfig.authMethods


cartridges? ​

optional cartridges: string | string[]

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:79

Cartridge names to include in deploy/watch (string with colon/comma separators, or array)

Inherited from ​

DwJsonConfig.cartridges


catalogs? ​

optional catalogs: string[]

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:83

Catalog IDs for WebDAV browsing

Inherited from ​

DwJsonConfig.catalogs


certificate? ​

optional certificate: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:89

Path to PKCS12 certificate file for mTLS (two-factor auth)

Inherited from ​

DwJsonConfig.certificate


certificatePassphrase? ​

optional certificatePassphrase: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:91

Passphrase for the certificate

Inherited from ​

DwJsonConfig.certificatePassphrase


cipHost? ​

optional cipHost: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:87

Optional CIP analytics host override

Inherited from ​

DwJsonConfig.cipHost


clientId? ​

optional clientId: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:45

OAuth client ID

Inherited from ​

DwJsonConfig.clientId


clientSecret? ​

optional clientSecret: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:47

OAuth client secret

Inherited from ​

DwJsonConfig.clientSecret


codeVersion? ​

optional codeVersion: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:39

Code version for deployments

Inherited from ​

DwJsonConfig.codeVersion


configs? ​

optional configs: DwJsonConfig[]

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:129

Array of named instance configurations


contentLibrary? ​

optional contentLibrary: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:81

Default content library ID for content export/list commands

Inherited from ​

DwJsonConfig.contentLibrary


hostname? ​

optional hostname: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:37

B2C instance hostname

Inherited from ​

DwJsonConfig.hostname


libraries? ​

optional libraries: string[]

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:85

Library IDs for WebDAV browsing

Inherited from ​

DwJsonConfig.libraries


mrtApiKey? ​

optional mrtApiKey: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:69

MRT API key

Inherited from ​

DwJsonConfig.mrtApiKey


mrtEnvironment? ​

optional mrtEnvironment: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:67

MRT environment name (e.g., staging, production)

Inherited from ​

DwJsonConfig.mrtEnvironment


mrtOrigin? ​

optional mrtOrigin: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:71

MRT cloud origin URL

Inherited from ​

DwJsonConfig.mrtOrigin


mrtProject? ​

optional mrtProject: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:65

MRT project slug

Inherited from ​

DwJsonConfig.mrtProject


name? ​

optional name: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:33

Instance name (for multi-config files)

Inherited from ​

DwJsonConfig.name


oauthScopes? ​

optional oauthScopes: string[]

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:49

OAuth scopes

Inherited from ​

DwJsonConfig.oauthScopes


password? ​

optional password: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:43

Password/access-key for Basic auth (WebDAV)

Inherited from ​

DwJsonConfig.password


realm? ​

optional realm: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:77

Default ODS realm for sandbox operations

Inherited from ​

DwJsonConfig.realm


safety? ​

optional safety: object

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:111

Safety configuration for this instance.

confirm? ​

optional confirm: boolean

level? ​

optional level: string

rules? ​

optional rules: object[]

Example ​

json
{
  "safety": {
    "level": "NO_UPDATE",
    "confirm": true,
    "rules": [
      { "job": "sfcc-site-archive-export", "action": "allow" },
      { "command": "sandbox:*", "action": "confirm" }
    ]
  }
}

Inherited from ​

DwJsonConfig.safety


sandboxApiHost? ​

optional sandboxApiHost: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:75

ODS API hostname

Inherited from ​

DwJsonConfig.sandboxApiHost


selfSigned? ​

optional selfSigned: boolean

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:93

Whether to skip SSL/TLS certificate verification (self-signed certs)

Inherited from ​

DwJsonConfig.selfSigned


shortCode? ​

optional shortCode: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:57

SCAPI short code

Inherited from ​

DwJsonConfig.shortCode


siteId? ​

optional siteId: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:55

B2C Commerce site/channel ID

Inherited from ​

DwJsonConfig.siteId


slasClientId? ​

optional slasClientId: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:51

SLAS client ID for shopper authentication

Inherited from ​

DwJsonConfig.slasClientId


slasClientSecret? ​

optional slasClientSecret: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:53

SLAS client secret for private shopper clients

Inherited from ​

DwJsonConfig.slasClientSecret


tenantId? ​

optional tenantId: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:73

Tenant/Organization ID for SCAPI

Inherited from ​

DwJsonConfig.tenantId


username? ​

optional username: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:41

Username for Basic auth (WebDAV)

Inherited from ​

DwJsonConfig.username


webdavHostname? ​

optional webdavHostname: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:59

Alternate hostname for WebDAV (if different from main hostname)

Inherited from ​

DwJsonConfig.webdavHostname

Released under the Apache-2.0 License.