Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEVDOCS-6188: [update] Login with JWT #882

Merged
merged 3 commits into from
Apr 8, 2025
Merged

DEVDOCS-6188: [update] Login with JWT #882

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
03170ec
DEVDOCS-6188: [update] Login with JWT
bc-traciporter Mar 27, 2025
db4a108
Update per Vitya's feedback
bc-traciporter Apr 7, 2025
06b1335
Merge branch 'main' into DEVDOCS-6188
bc-traciporter Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions docs/start/authentication/graphql-storefront.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,11 +144,16 @@ mutation Login($email: String!, $pass: String!) {

###### Login with a JWT

The second option is to use the `loginWithCustomerLoginJwt` mutation to pass your customer JSON web token instead of the user's email and password. In this scenario, you will generate a JWT that contains key information in the payload for the login to be successful. You will use this JWT in the login mutation to receive a customer access token.
There are two options for logging in using a JWT.

1. Customer Login API

The Customer Login API enables third-party services to securely authenticate a logged-in customer by accepting a signed JWT from BigCommerce. This allows the third party to verify the customer’s identity before granting access to sensitive information. For more details, see the [Customer Login API](/docs/start/authentication/customer-login) article.

2. `loginWithCustomerLoginJwt`

The `loginWithCustomerLoginJwt` mutation allows you to pass a customer JSON web token instead of the user's email and password. A 3rd party signs the JSON web token used. In this scenario, you will generate a JWT that contains key information in the payload for the login to be successful. You will use this JWT in the login mutation to receive a customer access token. For instructions on creating a JWT, see the [Customer Login API](/docs/start/authentication/customer-login) article for instructions.

<Callout type="info">
For information on creating a JWT, see the [Customer Login API](/docs/start/authentication/customer-login) article for instructions.
</Callout>

<Tabs items={['Request', 'Response']}>
<Tab>
Expand All @@ -175,7 +180,7 @@ mutation Login($jwt: String!) {
```

```json filename="GraphQL variables" showLineNumbers copy
{"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI3MjM3Mzc2Y3JiNnJrcTFhY2h3MmdrdTQ2M2FjeGk4IiwiaWF0IjoxNzIwODE0NjgyLCJqdGkiOiJhMDA1OGQ0MC0zNmExLTAxM2ItOTBmNC03ZThiMTE1MDA4YTIiLCJvcGVyYXRpb24iOiJjdXN0b21lcl9sb2dpbiIsInN0b3JlX2hhc2giOiJ3MGFzdGVlOWpvIiwiY3VzdG9tZXJfaWQiOjIyfQ.bfiEpk-IDCqQ4DqpErVCEUUQDjs-vtWxHsEufkUFqMs"
{"jwt": "your_jwt_token"
}
```
</Tab>
Expand Down