Skip to content

Commit 748bf31

Browse files
TAX-2677: docs(tax) - Add X-Auth-Token security scheme with MANAGE_TAX permission
Refs TAX-2677 Co-Authored-By: Claude <noreply@anthropic.com>
1 parent f75c223 commit 748bf31

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

reference/tax_classes.v3.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ servers:
2525
description: Permanent ID of the BigCommerce store.
2626
description: BigCommerce API Gateway
2727

28+
security:
29+
- X-Auth-Token: []
30+
2831
tags:
2932
- name: Tax Classes
3033
description: Create, update, and delete tax classes.
@@ -228,6 +231,32 @@ paths:
228231
$ref: '#/components/schemas/ProblemResponseEnvelope'
229232

230233
components:
234+
securitySchemes:
235+
X-Auth-Token:
236+
name: X-Auth-Token
237+
description: |-
238+
### OAuth scopes
239+
240+
| UI Name | Permission | Parameter |
241+
|:--------|:-----------|:----------|
242+
| Tax | modify | `MANAGE_TAX` |
243+
244+
### Authentication header
245+
246+
| Header | Argument | Description |
247+
|:-------|:---------|:------------|
248+
| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). |
249+
250+
### Further reading
251+
252+
For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests).
253+
254+
For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes).
255+
256+
For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes).
257+
type: apiKey
258+
in: header
259+
231260
schemas:
232261
TaxClassCreateBatch:
233262
type: array

0 commit comments

Comments
 (0)