asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Enhance Documentation for authenticate Middleware Function (#9898)

Browse Source 
Clarified usage of allowUnauthenticated and allowUnregistered options, explaining their roles in controlling access for unauthenticated and unregistered users.
This commit is contained in:
Mohsen
2024-11-11 13:36:05 +03:30
committed by GitHub
parent af51bd755b
commit a151865d0a
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
www/apps/book/app/learn/advanced-development/api-routes/protected-routes/page.mdx
View File

@@ -69,8 +69,9 @@ The `authenticate` middleware function accepts three parameters:
1. The type of user authenticating. Use `user` for authenticating admin users, and `customer` for authenticating customers. You can also pass `*` to allow all types of users.
2. An array of types of authentication methods allowed. Both `user` and `customer` scopes support `session` and `bearer`. The `admin` scope also supports the `api-key` authentication method.
3. An optional object of configurations accepting the following property:
3. An optional object of configurations accepting the following properties:
- `allowUnauthenticated`: (default: `false`) A boolean indicating whether authentication is required. For example, you may have an API route where you want to access the logged-in customer if available, but guest customers can still access it too.
- `allowUnregistered` (default: `false`): A boolean indicating if unregistered users should be allowed access. This is useful when you want to allow users who aren’t registered to access certain routes.
---