@salesforce/b2c-tooling-sdk / instance / FromEnvironmentOptions

Interface: FromEnvironmentOptions

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:64

Options for creating a B2CInstance from environment configuration.

Properties

authMethods?

optional authMethods: AuthMethod[]

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:88

Allowed auth methods in priority order

---

clientId?

optional clientId: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:82

OAuth client ID

---

clientSecret?

optional clientSecret: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:84

OAuth client secret

---

codeVersion?

optional codeVersion: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:74

Code version

---

configPath?

optional configPath: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:68

Path to dw.json (defaults to searching up from cwd)

---

hostname?

optional hostname: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:72

B2C instance hostname

---

instance?

optional instance: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:66

Named instance from dw.json "configs" array

---

password?

optional password: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:80

Password for Basic auth

---

scopes?

optional scopes: string[]

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:86

OAuth scopes

---

username?

optional username: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:78

Username for Basic auth

---

webdavHostname?

optional webdavHostname: string

Defined in: packages/b2c-tooling-sdk/src/instance/index.ts:76

WebDAV hostname (if different)