keycloakjs-redirect's Introduction

keycloakjs-redirect

Use case

A Frontend Javascript service that integrates with the Keycloak authentication service, guiding users to a login portal when a 401 Unauthorised response is received from an API.

Install

$ npm i keycloak-redirect

Configuration

Import the package, then use the object exposed to return the function authenticate, passing in all mandatory arguments: a config object, a XMLHttpRequest object, and window.

    
   import keycloakRedirect from 'keycloak-redirect';
   
   var config = {
       backend: "http://yourBackendUrl.com",
       clientId: "yourClientId",
       keycloakUrl: "http://yourKeycloakUrl.com"
   };
   
   keycloakRedirect.authenticate(config, new XMLHttpRequest(), $window);

Run Tests

$ npm test

Compile the code with babel

$ npm run compile

keycloakjs-redirect's People

Contributors

Stargazers

Watchers

keycloakjs-redirect's Issues

Make tests

even though its simple, this should have a test of some sort of test to assert that it works

Add MIT licence

Home Office repo clean up

Good morning,

We are looking to clean up some redundant repositories and this one has been raised for moving to attic.
If this is incorrect please drop me a reply or direct email on [email protected].

Thanks,
Rob