OAuth2 Token Revocation¶
The OAuth Token Revocation functionality is available with WSO2 Identity Server and follows this specification. There are two endpoints exposed as a result of the token revocation feature.
- REST endpoint at
- SOAP endpoint at
The REST endpoint is for OAuth 2.0 clients who want to revoke any access
granted to them by a resource owner. This could be at the discretion of
the resource owner or otherwise. In other words, this endpoint is meant
for OAuth 2.0 clients only in order to authenticate themselves using
revoke the authorization granted to them. They may use the access token
or refresh token for this purpose. Regardless of which token the client
uses, the result is the same; the client cannot access the user’s
resource again until such time the user explicitly provides a grant by
authorizing the client at the OAuth 2.0 authorization server.
The following is an example of the request that needs to be sent to the revocation REST endpoint by OAuth 2.0 client to revoke a token:
curl -X POST --basic -u "<client id>:<client secret>" -H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8" -k -d "token=<token to revoke>&token_type_hint=access_token" https://localhost:9443/oauth2/revoke
The token parameter used here can be an access token or refresh token.
token_type_hint parameter is optional. This
parameter can take values of either
refresh_token . The Identity Server uses this
parameter to speed up the process of looking up the token by searching
first in the set of tokens the client specifies (
If the token is not to be found in the set the client claims it to be
in, then the server looks for the token in the other set (
The SOAP endpoint, on the other hand, is for the resource owners to directly interact with the Authorization server and revoke authorization grants for applications they previously granted access to, without the OAuth 2.0 application/client being an intermediary in the process. The use of this SOAP endpoint is demonstrated by the WSO2 Identity Server’s dashboard under Authorized Apps ‘ for resource owners to login and revoke application authorization.
- Go to the user portal URL: https://localhost:9443/user-portal/ .
- Click the Login button.
- Enter your username and password and click the Sign In button. The dashboard appears.
- Click the View details button to access the components.
- Once you have logged in, click View details under Authorized
Apps. The following page appears, listing out the available
The Authorized Apps page indicates the user has granted
authorization to the application ‘
created by user ‘
The token revocation end-point also supports CORS (Cross-Origin Resource Sharing) specification and also JSONP (Remote JSON – JSONP).
CORS is supported through CORS-Filter which can be found
here. The CORS Filter
is designed to be plugged to a webapp using its deployment descriptor (
web.xml ). Since the OAuth 2.0 endpoints in WSO2
Identity Server have been written as JAX-RS endpoints, you can add the
required CORS configurations to its deployment descriptor.
You can find this webapp at
. Rather than editing the
web.xml directly in the
deployed directory, its easier to copy the
file into another location, edit the
web.xml and copy
it back into the
webapps folder and it gets hot
Example of a JSONP revocation request:
curl -X POST --basic -u "<client id>:<client secret>" -H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8" -k -d "token=<token to revoke>&token_type_hint=access_token&callback=package.myCallback" https://localhost:9443/oauth2/revoke
callback parameter is optional.
When a session is terminated via rest api, WSO2 Identity Server will revoke the mapped access token as well. There can be some instances where same access token is used across multiple sessions. Therefore, it is always recommended to use sso-session binding if you are using the session management REST API to terminate the sessions.