Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adrien2p committed Nov 15, 2023
1 parent 994b97f commit 03f4f1e
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/pages/authentication/auth0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ newly added plugins. To do so here are the steps
<CircleStep index={4}>
Update your client to add the authentication action

After authentication is successfull, the user will be redirected to the `successRedirect` url with a `?access_token=your_token` query param and a session cookie will be set. Session will automatically be authenticated. The access token is a JWT that can be used with Authorization: Bearer <token> header to authenticate requests to the backend instead of using a session cookie.
After authentication is successfull, the user will be redirected to the `successRedirect` url with a `?access_token=your_token` query param and a session cookie will be set. Session will automatically be authenticated. The access token is a JWT that can be used with Authorization: Bearer `<token>` header to authenticate requests to the backend instead of using a session cookie.
</CircleStep>

### Default behaviour
Expand All @@ -108,7 +108,7 @@ The default `verifyCallback` flow looks as follow (unless the `strict` option is

If you are using your Medusa application with a SPA or mobile frontend, you can request opt to receive the access token in a JSON response instead of a redirect.

To do this, you have to add ?returnAccessToken=true query parameter to your authentication call. Your authentication URL will then look like this: ${medusa_url}/${authPath}?returnAccessToken=true
To do this, you have to add ?returnAccessToken=true query parameter to your authentication call. Your authentication URL will then look like this: `${medusa_url}/${authPath}?returnAccessToken=true`

The response will look like this:
```json
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/authentication/azureoidc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ newly added plugins. To do so here are the steps
- `medusa_url` correspond to your backend server url (e.g `http://localhost:9000`)
- `authPath` correspond to `authPath` configuration in your plugin (e.g `admin/auth/azure`)

After authentication is successfull, the user will be redirected to the `successRedirect` url with a `?access_token=your_token` query param and a session cookie will be set. Session will automatically be authenticated. The access token is a JWT that can be used with Authorization: Bearer <token> header to authenticate requests to the backend instead of using a session cookie.
After authentication is successfull, the user will be redirected to the `successRedirect` url with a `?access_token=your_token` query param and a session cookie will be set. Session will automatically be authenticated. The access token is a JWT that can be used with Authorization: Bearer `<token>` header to authenticate requests to the backend instead of using a session cookie.
</CircleStep>

### Implementation Comments
Expand Down Expand Up @@ -139,7 +139,7 @@ The default `verifyCallback` flow looks as follow (unless the `strict` option is

If you are using your Medusa application with a SPA or mobile frontend, you can request opt to receive the access token in a JSON response instead of a redirect.

To do this, you have to add ?returnAccessToken=true query parameter to your authentication call. Your authentication URL will then look like this: ${medusa_url}/${authPath}?returnAccessToken=true
To do this, you have to add ?returnAccessToken=true query parameter to your authentication call. Your authentication URL will then look like this: `${medusa_url}/${authPath}?returnAccessToken=true`

The response will look like this:
```json
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/authentication/facebook.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ newly added plugins. To do so here are the steps
- `medusa_url` correspond to your backend server url (e.g `http://localhost:9000`)
- `authPath` correspond to `authPath` configuration in your plugin (e.g `admin/auth/facebook`)

After authentication is successfull, the user will be redirected to the `successRedirect` url with a `?access_token=your_token` query param and a session cookie will be set. Session will automatically be authenticated. The access token is a JWT that can be used with Authorization: Bearer <token> header to authenticate requests to the backend instead of using a session cookie.
After authentication is successfull, the user will be redirected to the `successRedirect` url with a `?access_token=your_token` query param and a session cookie will be set. Session will automatically be authenticated. The access token is a JWT that can be used with Authorization: Bearer `<token>` header to authenticate requests to the backend instead of using a session cookie.
</CircleStep>

### Default behaviour
Expand All @@ -114,7 +114,7 @@ The default `verifyCallback` flow looks as follow (unless the `strict` option is

If you are using your Medusa application with a SPA or mobile frontend, you can request opt to receive the access token in a JSON response instead of a redirect.

To do this, you have to add ?returnAccessToken=true query parameter to your authentication call. Your authentication URL will then look like this: ${medusa_url}/${authPath}?returnAccessToken=true
To do this, you have to add ?returnAccessToken=true query parameter to your authentication call. Your authentication URL will then look like this: `${medusa_url}/${authPath}?returnAccessToken=true`

The response will look like this:
```json
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/authentication/google.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ newly added plugins. To do so here are the steps
- `medusa_url` correspond to your backend server url (e.g `http://localhost:9000`)
- `authPath` correspond to `authPath` configuration in your plugin (e.g `admin/auth/google`)

After authentication is successfull, the user will be redirected to the `successRedirect` url with a `?access_token=your_token` query param and a session cookie will be set. Session will automatically be authenticated. The access token is a JWT that can be used with Authorization: Bearer <token> header to authenticate requests to the backend instead of using a session cookie.
After authentication is successfull, the user will be redirected to the `successRedirect` url with a `?access_token=your_token` query param and a session cookie will be set. Session will automatically be authenticated. The access token is a JWT that can be used with Authorization: Bearer ``<token>`` header to authenticate requests to the backend instead of using a session cookie.
</CircleStep>

### Default behaviour
Expand All @@ -114,7 +114,7 @@ The default `verifyCallback` flow looks as follow (unless the `strict` option is

If you are using your Medusa application with a SPA or mobile frontend, you can request opt to receive the access token in a JSON response instead of a redirect.

To do this, you have to add ?returnAccessToken=true query parameter to your authentication call. Your authentication URL will then look like this: ${medusa_url}/${authPath}?returnAccessToken=true
To do this, you have to add ?returnAccessToken=true query parameter to your authentication call. Your authentication URL will then look like this: `${medusa_url}/${authPath}?returnAccessToken=true`

The response will look like this:
```json
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/authentication/linkedin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ newly added plugins. To do so here are the steps
- `medusa_url` correspond to your backend server url (e.g `http://localhost:9000`)
- `authPath` correspond to `authPath` configuration in your plugin (e.g `admin/auth/linkedin`)

After authentication is successfull, the user will be redirected to the `successRedirect` url with a `?access_token=your_token` query param and a session cookie will be set. Session will automatically be authenticated. The access token is a JWT that can be used with Authorization: Bearer <token> header to authenticate requests to the backend instead of using a session cookie.
After authentication is successfull, the user will be redirected to the `successRedirect` url with a `?access_token=your_token` query param and a session cookie will be set. Session will automatically be authenticated. The access token is a JWT that can be used with Authorization: Bearer `<token>` header to authenticate requests to the backend instead of using a session cookie.
</CircleStep>

### Default behaviour
Expand All @@ -114,7 +114,7 @@ The default `verifyCallback` flow looks as follow (unless the `strict` option is

If you are using your Medusa application with a SPA or mobile frontend, you can request opt to receive the access token in a JSON response instead of a redirect.

To do this, you have to add ?returnAccessToken=true query parameter to your authentication call. Your authentication URL will then look like this: ${medusa_url}/${authPath}?returnAccessToken=true
To do this, you have to add ?returnAccessToken=true query parameter to your authentication call. Your authentication URL will then look like this: `${medusa_url}/${authPath}?returnAccessToken=true`

The response will look like this:
```json
Expand Down

1 comment on commit 03f4f1e

@vercel
Copy link

@vercel vercel bot commented on 03f4f1e Nov 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

medusa-plugins – ./

medusa-plugins.vercel.app
medusa-plugins-git-main-adrien2p.vercel.app
medusa-plugins-adrien2p.vercel.app

Please sign in to comment.