-
Notifications
You must be signed in to change notification settings - Fork 399
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add multiple-active-access-tokens documentation.
Fixes #8376 for APIM 4.1.0
- Loading branch information
Showing
2 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
43 changes: 43 additions & 0 deletions
43
en/docs/design/api-security/oauth2/multiple-active-access-tokens.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Multiple Active Access Tokens | ||
|
||
WSO2 API Manager by default allows only one active access token to be in existence for the same Consumer Key, User and Scope combination at a given time. This behaviour can be modified to allow multiple access tokens as described in the following sections. | ||
|
||
## JWT | ||
|
||
When issuing `JWT` tokens before the expiry or revocation of the previous token, the default behaviour is to revoke the previous token and issue a new token. With the following configuration, it can be configured to issue a new token before expiry and without revoking the old token, allowing the existence of multiple active access tokens at the same time. | ||
|
||
```toml | ||
[oauth.jwt.renew_token_without_revoking_existing] | ||
enable = true | ||
``` | ||
|
||
By default only the `client_credentials` grant type is allowed to generate multiple access tokens. This can be configured by the following configuration. | ||
|
||
```toml | ||
[oauth.jwt.renew_token_without_revoking_existing] | ||
enable = true | ||
allowed_grant_types = [“client_credentials”, “password”] | ||
``` | ||
|
||
!!! note | ||
If you are customizing the `allowed_grant_types` make sure to add or remove the default value `client_credentials` as per the requirement. | ||
|
||
## Opaque | ||
|
||
When issuing `opaque` tokens before the expiry or revocation of the previous token, the default behaviour is to issue the existing token which is stored in the DB. With the following configuration, it can be configured to allow the existence of multiple active access tokens at the same time. | ||
|
||
```toml | ||
[oauth.opaque.renew_token_without_revoking_existing] | ||
enable = true | ||
``` | ||
|
||
By default only the `client_credentials` grant type is allowed to generate multiple access tokens. This can be configured by the following configuration. | ||
|
||
```toml | ||
[oauth.opaque.renew_token_without_revoking_existing] | ||
enable = true | ||
allowed_grant_types = [“client_credentials”, “password”] | ||
``` | ||
|
||
!!! note | ||
If you are customizing the `allowed_grant_types` make sure to add or remove the default value `client_credentials` as per the requirement. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters