fastify-txstate-unified-auth v0.2.32

fastify-txstate-unified-auth

Fastify plugin for using mobile/web system's unified auth solution

Basic Usage

server.app.register(unifiedAuth, {
  clientId: 'yourservicename',
  unifiedAuthHost: 'https://unifiedAuthHost.edu', 
  unifiedAuthValidateHost: 'https://unified-auth', 
  defaultRedirect: '/test', 
  tokenLocation: 'cookie' 
})

Config

serviceName: string

The name of your service. Unified auth will check to make sure this service has been registered before signing a token. This serviceName will also end up in the token payload.

unifiedAuthHost: string

Base URL that the middleware will redirect to when a user needs to login.

unifiedAuthValidateHost?: string

In most cases this will be unnecessary and will default to using unifiedAuthHost if none is provided. There are some cases, especially when using Docker, when it becomes impossible to send network requests to the same place you redirect a browser to. In the case of using a local unifiedAuthHost container using docker-compose, you would set this to http://unified-auth-container-name

defaultRedirect: string

if the user was not trying to access a specific route to begin with, where do you want to send them after successful login?

tokenLocation: 'cookie' || 'bearer (default 'cookie')

Do you want to put the token in a cookie, or return it your defaultRedirect route as a query param? If returning it as query param, your front-end application will be responsible for sending it as a bearer token with every request to an authenticated route