Skip to content

Commit 83e56f0

Browse files
charIeszhaogao-sun
andauthored
refactor: improve docs for rotate refresh token (#784)
* refactor: improve docs for rotate refresh token * refactor: update per comments Co-authored-by: Gao Sun <gao@silverhand.io> --------- Co-authored-by: Gao Sun <gao@silverhand.io>
1 parent 10099ab commit 83e56f0

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/docs/references/applications/README.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,16 +111,17 @@ However, this practice is discouraged unless necessary (usually it's useful for
111111

112112
<Availability cloud oss={{ major: 1, minor: 6 }} />
113113

114-
_Availability: Traditional web, Machine-to-machine; Default: `true`_
114+
_Default: `true`_
115115

116-
When enabled, Logto will issue a new Refresh Token for token requests under the following conditions:
116+
When enabled, Logto will issue a new refresh token for token requests under the following conditions:
117117

118-
- If the time elapsed since the refresh token was last rotated is less than 1 year; and
119-
- If 70% of the original Time to Live (TTL) has passed; or
120-
- If the client is a non-sender-constrained public client.
118+
- If the refresh token has been rotated (have its TTL prolonged by issuing a new one) for one year; **OR**
119+
- If the refresh token is close to its expiration time (>=70% of its original Time to Live (TTL) passed); **OR**
120+
- If the client is a public client, e.g. Native application or single page application (SPA).
121121

122122
:::note
123-
If the application type is not available for this switch, it means a new refresh token will be always issued for each token request.
123+
For public clients, when this feature is enabled, a new refresh token will always be issued when the client is exchanging for a new access token using the refresh token.
124+
Although you can still turn off the feature for those public clients, it is highly recommended to keep it enabled for security reasons.
124125
:::
125126

126127
### Refresh Token Time to Live (TTL) in days

0 commit comments

Comments
 (0)