Skip to content

Commit a2858cc

Browse files
mjsalingerthomseddon
authored andcommitted
Merge pull request oauthjs#471 from smartrecruiters/fix-migration-documentaiton
docs: Correct tokens time scale for 2.x to 3.x migration guide
1 parent 88a6cd7 commit a2858cc

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/misc/migrating-v2-to-v3.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,17 @@ The naming of the exposed middlewares has changed to match the OAuth2 _RFC_ more
2828
Server options
2929
--------------
3030

31-
The following server options can be set when instantiating the OAuth service:
31+
The following server options can be set when instantiating the OAuth service:
3232

3333
* `addAcceptedScopesHeader`: **default true** Add the `X-Accepted-OAuth-Scopes` header with a list of scopes that will be accepted
3434
* `addAuthorizedScopesHeader`: **default true** Add the `X-OAuth-Scopes` header with a list of scopes that the user is authorized for
3535
* `allowBearerTokensInQueryString`: **default false** Determine if the bearer token can be included in the query string (i.e. `?access_token=`) for validation calls
3636
* `allowEmptyState`: **default false** If true, `state` can be empty or not passed. If false, `state` is required.
37-
* `authorizationCodeLifetime`: **default 300** Default number of milliseconds that the authorization code is active for
38-
* `accessTokenLifetime`: **default 3600** Default number of milliseconds that an access token is valid for
39-
* `refreshTokenLifetime`: **default 1209600** Default number of milliseconds that a refresh token is valid for
37+
* `authorizationCodeLifetime`: **default 300** Default number of seconds that the authorization code is active for
38+
* `accessTokenLifetime`: **default 3600** Default number of seconds that an access token is valid for
39+
* `refreshTokenLifetime`: **default 1209600** Default number of seconds that a refresh token is valid for
4040
* `allowExtendedTokenAttributes`: **default false** Allows additional attributes (such as `id_token`) to be included in token responses.
41-
* `requireClientAuthentication`: **default true for all grant types** Allow ability to set client/secret authentication to `false` for a specific grant type.
41+
* `requireClientAuthentication`: **default true for all grant types** Allow ability to set client/secret authentication to `false` for a specific grant type.
4242

4343
The following server options have changed behavior in v3.0.0:
4444

@@ -60,7 +60,7 @@ Model specification
6060
* `generateAuthorizationCode()` is **optional** and should return a `String`.
6161
* `generateRefreshToken(client, user, scope)` is **optional** and should return a `String`.
6262
* `getAccessToken(token)` should return an object with:
63-
63+
6464
* `accessToken` (`String`)
6565
* `accessTokenExpiresAt` (`Date`)
6666
* `client` (`Object`), containing at least an `id` property that matches the supplied client
@@ -75,7 +75,7 @@ Model specification
7575
* `user` (`Object`)
7676

7777
* `getClient(clientId, clientSecret)` should return an object with, at minimum:
78-
78+
7979
* `redirectUris` (`Array`)
8080
* `grants` (`Array`)
8181

@@ -88,11 +88,11 @@ Model specification
8888
* `user` (`Object`)
8989

9090
* `getUser(username, password)` should return an object:
91-
91+
9292
* No longer requires that `id` be returned.
9393

9494
* `getUserFromClient(client)` should return an object:
95-
95+
9696
* No longer requires that `id` be returned.
9797

9898
* `grantTypeAllowed()` was **removed**. You can instead:

0 commit comments

Comments
 (0)