import OAuth from '@mapcreator/api/src/oauth/OAuth.js'

public class | source

OAuth

OAuth base class

Constructor Summary

Public Constructor
public	constructor(clientId: String, scopes: Array<String>)

Public Members
public get	authenticated: Boolean: * If the current instance has a valid token
public	clientId: *
public	host: *
public	path: *
public	scopes: *
public	token: *

Public Methods
public abstract	authenticate(): Promise<OAuthToken> Authenticate
public	forget() Forget the current session Empty the session token store and forget the api token
public	importToken(token: String, type: String, expires: Date \| Number, scopes: Array<string>) Manually import OAuthToken, usefull for debugging
public	logout(): CancelablePromise Invalidates the session token

If the current instance has a valid token

If a valid token is available

Authenticate

Authentication token

Forget the current session Empty the session token store and forget the api token

Manually import OAuthToken, usefull for debugging

Name	Type	Attribute	Description
token	String		OAuth token
type	String	optional default: Bearer	token type
expires	Date \| Number	optional default: 5 days	expire time in seconds or Date
scopes	Array<string>	optional default: []	Any scopes

Invalidates the session token

OAuthError	If de-authentication fails
ApiError	If the api returns errors