@salesforce/b2c-tooling-sdk / clients / BuildScapiClientOptions
Interface: BuildScapiClientOptions
Defined in: packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:31
Properties
defaultScopes?
optionaldefaultScopes:string[]
Defined in: packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:55
Legacy: a single scope set requested for every operation. Used by domains that still rely on ScopeTierManager to switch clients between rw and ro. Mutually exclusive with scopeCascade.
Deprecated
Use scopeCascade for new domains.
domainKey
domainKey:
HttpClientType
Defined in: packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:40
Middleware registry key, e.g. 'scapi-jobs'. Plugin middleware registered under this key gets installed on the client.
logPrefix
logPrefix:
string
Defined in: packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:59
Logging/rate-limit prefix, e.g. 'SCAPI-JOBS'. Used in log lines.
pathSegment
pathSegment:
string
Defined in: packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:35
URL path segment after the SCAPI host root, e.g. 'operation/jobs/v1'.
scopeCascade?
optionalscopeCascade:ScopeCascade
Defined in: packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:47
Per-operation scope cascade. When supplied, operations attach a x-b2c-scope-mode header ('read' or 'write') and the auth middleware walks the matching cascade until AM accepts one. Mutually exclusive with defaultScopes; new domains should prefer this.