Skip to content

Commit

Permalink
Updated security b2b authentication details (#557)
Browse files Browse the repository at this point in the history
<!-- Ticket number or summary of work -->
# [DEVDOCS-5655]


## What changed?
Updating security information

## Release notes draft

n/a 

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {names}


[DEVDOCS-5655]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-5655?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
bc-traciporter authored Oct 3, 2024
1 parent 99c83e1 commit 88ac21e
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 17 deletions.
16 changes: 12 additions & 4 deletions docs/b2b-edition/specs/storefront/storefront/catalog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@ info:
title: Catalog
version: '1.0'
description: The Catalog refers to a store’s collection of physical and digital products.
contact:
name: BigCommerce
url: 'https://www.bigcommerce.com'
email: [email protected]
servers:
- url: 'https://api-b2b.bigcommerce.com/api/v2'
security:
- authToken: []
- BearerToken: []
paths:
/catalogs/variants:
get:
Expand Down Expand Up @@ -364,9 +368,13 @@ paths:
components:
schemas: {}
securitySchemes:
authToken:
name: authToken
description: Include the `authToken` in a header parameter.
BearerToken:
name: BearerToken
description: |-
### Authentication header
| Header | Argument | Description |
|:-------|:---------|:------------|
|`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| Obtained using the [BigCommerce Current Customer API](/docs/rest-authentication/current-customer) endpoint. |
type: apiKey
in: header
tags:
Expand Down
26 changes: 13 additions & 13 deletions docs/b2b-edition/specs/storefront/storefront/sales-rep.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@ info:
title: Super Admin
version: '1.0'
description: Super Admin is a group of sales representatives assigned to the company.
contact:
name: BigCommerce
url: 'https://www.bigcommerce.com'
email: [email protected]
servers:
- url: 'https://api-b2b.bigcommerce.com/api/v2'
security:
- BearerToken: []
paths:
'/sales-reps/{userId}/companies/{companyId}/begin-masq':
parameters:
Expand Down Expand Up @@ -84,8 +90,6 @@ paths:
Equivalent Storefront GraphQL API Mutation: `superAdminBeginMasquerade`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).
tags:
- Super Admin
security:
- authToken: []
'/sales-reps/{userId}/companies/{companyId}/end-masq':
parameters:
- schema:
Expand Down Expand Up @@ -140,8 +144,6 @@ paths:
Equivalent Storefront GraphQL API Mutation: `superAdminEndMasquerade`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).
tags:
- Super Admin
security:
- authToken: []
'/sales-reps/{customerId}/companies/masquerading':
parameters:
- schema:
Expand Down Expand Up @@ -456,8 +458,6 @@ paths:
Equivalent Storefront GraphQL API Query: `superAdminCompanies`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).
tags:
- Super Admin
security:
- authToken: []
parameters:
- schema:
type: integer
Expand Down Expand Up @@ -540,18 +540,18 @@ paths:
description: Update super admin assign company.
tags:
- Super Admin
security:
- authToken: []
x-internal: true
components:
schemas: {}
securitySchemes:
authToken:
name: authToken
description: Include the `authToken` in a header parameter.
BearerToken:
name: BearerToken
description: |-
### Authentication header
| Header | Argument | Description |
|:-------|:---------|:------------|
|`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| Obtained using the [BigCommerce Current Customer API](/docs/rest-authentication/current-customer) endpoint. |
type: apiKey
in: header
security:
- authToken: []
tags:
- name: Super Admin

0 comments on commit 88ac21e

Please sign in to comment.