new AccessToken()
AccessToken extension to the User interface
Methods
accessToken() → {Object}
The Access Token if present parsed as a JsonObject
Returns:
JSON
- Type
- Object
clearCache() → {User}
Returns:
- Type
- User
expired() → {boolean}
Check if the access token is expired or not.
Returns:
- Type
- boolean
fetch(method, resource, headers, payload, callback) → {AccessToken}
Fetches a JSON resource using this Access Token.
Parameters:
| Name | Type | Description |
|---|---|---|
method |
Object | the HTTP method to user. |
resource |
string | the resource to fetch. |
headers |
Object | extra headers to pass to the request. |
payload |
Buffer | payload to send to the server. |
callback |
function | The callback function returning the results. |
Returns:
- Type
- AccessToken
introspect(tokenType, 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 |
|---|---|---|
tokenType |
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. |
Returns:
- Type
- AccessToken
isAuthorised(authority, resultHandler) → {User}
Parameters:
| Name | Type | Description |
|---|---|---|
authority |
string | |
resultHandler |
function |
Returns:
- Type
- User
isAuthorized(arg0, arg1) → {User}
Parameters:
| Name | Type | Description |
|---|---|---|
arg0 |
string | |
arg1 |
function |
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. |
Returns:
- Type
- AccessToken
principal() → {Object}
Returns:
- Type
- Object
refresh(callback) → {AccessToken}
Refresh the access token
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function | The callback function returning the results. |
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. |
Returns:
- Type
- AccessToken
setAuthProvider(arg0)
Parameters:
| Name | Type | Description |
|---|---|---|
arg0 |
AuthProvider |
userInfo(callback) → {AccessToken}
Load the user info as per OIDC spec.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function | The callback function returning the results. |
Returns:
- Type
- AccessToken