Comment on page
BaseAuth
This class is an interface, it shouldn't be created directly.
The application that this object is associated with.
The Vulos Identity server endpoint URL.
This should only get called by classes that inherit the
BaseAuth class.endpointshould be a string or afalsevalue (likenullorundefined) that represents the Vulos Identity endpoint.
// the constructor is called inside of the createAuth method of `Application`
import { BackendAuth } from "@vulos/identity-node-sdk"
const auth = applicaion.createAuth(BackendAuth)
Connect the authentication object to the Vulos Identity servers.
This should get called before any other functions.
await auth.connect()
Create a verifier that other functions would take as an argument (as
authVerifier).A verifier is an object that contains some value that will be used to verify if the server's response is valid.
It's recommended create one verifier per authentication request.
const verifier = auth.createVerifier()
Create an authentication/consent URL for a user.
const url = await auth.createAuthUrl(verifier)
// redirect the user to the URL
Process the callback URL query parameters (or fragment parameters if using the implicit flow) to get a
User object.// req is an object that is supposed to be a HTTP request in this example
const user = await auth.processCallback(verifier, req.query)
const userInfo = await auth.getUserInfo()
Get a new OpenID token set using a refresh token.
const { access_token, refresh_token, id_token, token_type, expires_at}
= await auth.refreshTokens(refreshToken)
This probably shouldn't get called directly, it's called automatically when needed.
Last modified 1yr ago