FusionAuth Vue SDK
Overview
This SDK allows you to add login, logout, and registration buttons to your Vue application. You can do this via pre-built buttons, or with the FusionAuthService in your own components.
Your users will be sent to FusionAuth’s themeable hosted login pages and then log in. After that, they are sent back to your Vue application.
Once authentication succeeds, the following secure, HTTP-only cookies will be set:
app.at
- an OAuth Access Tokenapp.rt
- a Refresh Token used to obtain a newapp.at
. This cookie will only be set if refresh tokens are enabled on your FusionAuth instance.
The access token can be presented to APIs to authorize the request and the refresh token can be used to get a new access token.
Note that this SDK requires you to have a server that performs the OAuth token exchange. See Server Code Requirements for more details.
You can use this library against any version of FusionAuth or any OIDC compliant identity server.
Getting Started
Installation
NPM:
npm install @fusionauth/vue-sdk
Yarn:
yarn add @fusionauth/vue-sdk
Configuring the Vue SDK
To configure the SDK, initialize the FusionAuthVuePlugin
when you init your Vue app:
const app = createApp(App)
app.use(FusionAuthVuePlugin, {
clientId: '',
serverUrl: '',
redirectUri: '',
});
app.mount('#app')
If you want to use the pre-styled buttons, don't forget to import the css file:
import '@fusionauth/vue-sdk/dist/style.css';
Server Code Requirements
The FusionAuth Vue SDK was built against the Hosted Backend API, but can also be used with any server that will perform the OAuth token exchange. This server must have the following endpoints:
GET /app/login
This endpoint must:
- Generate PKCE code. a. The code verifier should be saved in a secure HTTP-only cookie. b. The code challenge is passed along
- Encode and save
redirect_url
from vue app tostate
. - Redirect browser to
/oauth2/authorize
with aredirect_uri
to/app/token-exchange
GET /app/callback
This endpoint must:
Call /oauth2/token to complete the Authorization Code Grant request. The
code
comes from the request query parameter andcode_verifier
should be available in the secure HTTP-only cookie, while the rest of the parameters should be set/configured on the server side.Once the token exchange succeeds, read the
app.at
from the response body and set it as a secure, HTTP-only cookie with the same name.If you wish to support refresh tokens, repeat step 2 for the
app.rt
cookie.Save the expiration time in a readable
app.at_exp
cookie. And save theapp.idt
id token in a readable cookie.Redirect browser back to encoded url saved in
state
.Call /oauth2/userinfo to retrieve the user info object and respond back to the client with this object.
GET /app/register
This endpoint is similar to /login
. It must:
- Generate PKCE code. a. The code verifier should be saved in a secure HTTP-only cookie. b. The code challenge is passed along
- Encode and save
redirect_url
from vue app tostate
. - Redirect browser to
/oauth2/register
with aredirect_uri
to/app/callback
GET /app/me
This endpoint must:
- Use
app.at
from cookie and use as the Bearer token to call/oauth2/userinfo
- Return json data
GET /app/logout
This endpoint must:
- Clear the
app.at
andapp.rt
secure, HTTP-only cookies. - Clear the
app.at_exp
andapp.idt
secure cookies. - Redirect to
/oauth2/logout
POST /app/refresh
(optional)
This endpoint is necessary if you wish to use refresh tokens. This endpoint must:
Call /oauth2/token to get a new
app.at
andapp.rt
.Update the
app.at
,app.at_exp
,app.idt
, andapp.rt
cookies from the response.
Usage
Pre-built buttons
There are three pre-styled buttons that are configured to perform login/logout/registration. They can be placed anywhere in your app as is.
<template>
<FusionAuthLoginButton/>
<FusionAuthLogoutButton/>
<FusionAuthRegisterButton/>
</template>
<style>
:root {
--fusionauth-button-background-color: #096324;
--fusionauth-button-text-color: #fff;
}
</style>
With the CSS variables, you can customize the buttons to match your app’s style.
Service usage
Alternatively, you may interact with the SDK Service by using the composable useFusionAuth
.
<template>
<button @click="fusionAuth.login">Login</button>
<button @click="fusionAuth.logout">Logout</button>
<button @click="fusionAuth.register">Register</button>
</template>
<script setup lang="ts">
import {useFusionAuth} from "@fusionauth/vue-sdk";
const fusionAuth = useFusionAuth();
</script>
State parameter
The login
and register
functions both accept an optional string
parameter called state
. The login and register components can also be passed the
state as a prop. The state that is passed in to the function call will be echoed
back in the state query parameter of the callback uri specified in redirectUri
on
the FusionAuthConfig
used to initialize the FusionAuthVuePlugin
. Though you may
pass any value you would like for the state parameter, it is often used to indicate
which page the user was on before redirecting to login or registration, so that the
user can be returned to that location after a successful authentication.