---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [clients](../index.md) / BuildScapiClientOptions

# Interface: BuildScapiClientOptions

Defined in: [packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:31](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts#L31)

## Properties

### ~~defaultScopes?~~

> `optional` **defaultScopes**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:55](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts#L55)

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](#scopecascade).

#### Deprecated

Use [scopeCascade](#scopecascade) for new domains.

***

### domainKey

> **domainKey**: [`HttpClientType`](../type-aliases/HttpClientType.md)

Defined in: [packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:40](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts#L40)

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](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts#L59)

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](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts#L35)

URL path segment after the SCAPI host root, e.g. `'operation/jobs/v1'`.

***

### scopeCascade?

> `optional` **scopeCascade**: `ScopeCascade`

Defined in: [packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts:47](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/scapi-client-factory.ts#L47)

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](#defaultscopes); new domains should prefer this.