ember-practical-oidc

2.0.1 • Public • Published

Ember Practical OIDC

npm version Ember Observer Score Build Status Code Climate

Installation

Like most ember addons, simply run ember install ember-practical-oidc and you should be all set as far as installation goes.

Configuration

Mandatory Configuration

environment.js

Here's the mandatory information you'll have to supply the addon using the config/environment.js file of your application. Without these four properties, it's impossible to construct a valid authentication payload.

ENV.OIDC = {
  applicationName: '<YOUR APP NAME>',
  applicationURL: '<YOUR APP URL>',
  authenticationURL: '<YOUR AUTHENTICATION ENDPOINT>',
  requestedScopes: '<THE REQUESTED SCOPES>'
};

Optional Configuration

Here are the additional configuration parameters that are available.

Property Key Default Value Type
popupRedirectURL "popup" string
silentRedirectURL "renew" string
responseType "id_token token" string
postLogoutRedirectURL "" string
checkSessionInterval 30000 int
automaticSilentRenew false boolean
filterProtocolClaims true boolean
loadUserInfo true boolean
transitionToRedirect null string
usePopup true boolean
useInPlaceRedirect true boolean
transitionExceptionList true string[]

to use the redirection logic instead of the default popup

set usePopup to false and give the post login transition to execute to transitionToRedirect

optionally set useInPlaceRedirect to return to the same route after login, by default the root "/" will be ignored from this redirection and redirect to transitionToRedirect instead.

this behaviour can be controlled by an exception list. every route found in transitionExceptionList will transition back to transitionToRedirect.

Route Initialization Configuration

The addon is able to automatically create the renew and popup routes for you. If that's what you want, simply set the ENV.OIDC.initializeRoutes environmnet variable to true in your config/environment.js file.

Debug Configuration

It's possible to view logging information by setting the ENV.OIDC.enableLogging environment variable to true.

Package Sidebar

Install

npm i ember-practical-oidc

Weekly Downloads

1

Version

2.0.1

License

MIT

Unpacked Size

1.45 MB

Total Files

22

Last publish

Collaborators

  • oreoz
  • shadowere
  • mechabear
  • marcus_91
  • alanlalonde
  • piknik