Class: AccessToken

vertx-auth-oauth2-js/access_token~ AccessToken

new AccessToken()

AccessToken extension to the User interface
Source:

Methods

clearCache() → {User}

Source:
Returns:
Type
User

expired() → {boolean}

Check if the access token is expired or not.
Source:
Returns:
Type
boolean

introspect(callback) → {AccessToken}

Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.
Parameters:
Name Type Description
callback function The callback function returning the results.
Source:
Returns:
Type
AccessToken

isAuthorised(arg0, arg1) → {User}

Parameters:
Name Type Description
arg0 string
arg1 function
Source:
Returns:
Type
User

logout(callback) → {AccessToken}

Revoke refresh token and calls the logout endpoint. This is a openid-connect extension and might not be available on all providers.
Parameters:
Name Type Description
callback function The callback function returning the results.
Source:
Returns:
Type
AccessToken

principal() → {Object}

Source:
Returns:
Type
Object

refresh(callback) → {AccessToken}

Refresh the access token
Parameters:
Name Type Description
callback function The callback function returning the results.
Source:
Returns:
Type
AccessToken

revoke(token_type, callback) → {AccessToken}

Revoke access or refresh token
Parameters:
Name Type Description
token_type string A String containing the type of token to revoke. Should be either "access_token" or "refresh_token".
callback function The callback function returning the results.
Source:
Returns:
Type
AccessToken

setAuthProvider(arg0)

Parameters:
Name Type Description
arg0 AuthProvider
Source: