Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bellgasp/ember-practical-oidc

ember ember-addon oidc

Last synced: 27 days ago
JSON representation

Host: GitHub
URL: https://github.com/bellgasp/ember-practical-oidc
Owner: BellGasp
License: mit
Created: 2017-07-18T17:59:16.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-03-02T08:11:04.000Z (over 1 year ago)
Last Synced: 2024-04-14T10:53:42.268Z (7 months ago)
Topics: ember, ember-addon, oidc
Language: JavaScript
Size: 3.72 MB
Stars: 2
Watchers: 5
Forks: 4
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # Ember Practical OIDC

[![npm version](https://badge.fury.io/js/ember-practical-oidc.svg)](https://badge.fury.io/js/ember-practical-oidc)

[![Ember Observer Score](https://emberobserver.com/badges/ember-practical-oidc.svg)](https://emberobserver.com/addons/ember-practical-oidc)

[![Build Status](https://travis-ci.com/BellGasp/ember-practical-oidc.svg?branch=master)](https://travis-ci.com/BellGasp/ember-practical-oidc)

[![Code Climate](https://codeclimate.com/github/BellGasp/ember-practical-oidc/badges/gpa.svg)](https://codeclimate.com/github/BellGasp/ember-practical-oidc)

## 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.

```js

ENV.OIDC = {

  applicationName: '',

  applicationURL: '',

  authenticationURL: '',

  requestedScopes: ''

};

```

### 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`.