@salesforce/b2c-tooling-sdk / clients / CommerceApiClientOptions
Interface: CommerceApiClientOptions
Defined in: packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:92
Options for buildCommerceApiClientRequest and provisionCommerceApiClient.
Properties
active?
optionalactive:boolean
Defined in: packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:111
Create the client enabled. Default true.
description?
optionaldescription:string
Defined in: packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:105
Optional description shown in Account Manager.
name
name:
string
Defined in: packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:94
API client name shown in Account Manager.
organizationId
organizationId:
string
Defined in: packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:96
Account Manager organization ID the client belongs to.
password?
optionalpassword:string
Defined in: packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:109
Client password (secret). Default: generateApiClientPassword.
scopes
scopes: readonly
string[]
Defined in: packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:103
OAuth scopes the client may request (e.g. sfcc.products, sfcc.catalogs). They are also set as the client's default scopes.
tenants
tenants: readonly
string[]
Defined in: packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:98
Tenants the client may access through SCAPI (e.g. zzzz_001 or f_ecom_zzzz_001).
tokenEndpointAuthMethod?
optionaltokenEndpointAuthMethod:"client_secret_post"|"client_secret_basic"
Defined in: packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:107
How the client authenticates at the token endpoint. Default client_secret_basic (Account Manager does not support client_secret_post).