Skip to content

[5.7] Document default scope in Passport #4815

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

Merged
merged 1 commit into from
Dec 7, 2018
Merged

[5.7] Document default scope in Passport #4815

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions passport.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
- [Passing The Access Token](#passing-the-access-token)
- [Token Scopes](#token-scopes)
- [Defining Scopes](#defining-scopes)
- [Default Scope](#default-scope)
- [Assigning Scopes To Tokens](#assigning-scopes-to-tokens)
- [Checking Scopes](#checking-scopes)
- [Consuming Your API With JavaScript](#consuming-your-api-with-javascript)
Expand Down Expand Up @@ -654,6 +655,15 @@ You may define your API's scopes using the `Passport::tokensCan` method in the `
'check-status' => 'Check order status',
]);

<a name="default-scope"></a>
### Default Scope

If a client decides to omit the scope the server still choose to set a default scope. You can achieve setting a default scope by using the `setDefaultScope`. Values need to be separated with a space or be passed as an array:

use Laravel\Passport\Passport;

Passport::setDefaultScope('place-orders check-status');

<a name="assigning-scopes-to-tokens"></a>
### Assigning Scopes To Tokens

Expand Down