Code Monkey home page Code Monkey logo

keycloak-utils's Introduction

Keycloak-Utils

utiles module to keycloak ()

Installation

Use the package manager npm to install foobar.

npm install keycloak-utils --save

Usage

import keycloakUtils from 'keycloak-utils'
//or
const KeycloakUtils = require('keycloak-utils')

const configKeycloak = {
    realm: 'myRealm',
    serverUrl: 'http://localhost:8080',
    clientId: 'myClient',
    clientSecret: 'myClientSecret'
}

const keycloakUtils = new KeycloakUtils(configKeycloak)

Example

!async function {
  try {
    /**
    * @description returns Aceess Token
    * @param userName username
    * @param Password password
    */
    const AccessToken = await KeycloakUtils.accessToken.getToken(userName, Password)

    /**
    * @description check if the token is valid
    * @param token access token
    */
    const isVerify = await KeycloakUtils.jwt.verify(token)
  } catch (e) {
    console.error(e)
  }
}()

/**
*@description decode token
* @param token AccessToken
*/
let decode = KeycloakUtils.jwt.decode(token)


// TOKEN INFORMATION
/**
* @description returns true if the token is expired and false otherwise
*/
let isExpired = KeycloakUtils.Token.isExpired()

/**
* @description look for a role in the app
* @param clientId name of the client
* @param roleName name of the role
*/
let hasApplicationRole = KeycloakUtils.Token.hasApplicationRole(clientId, roleName)

/**
* @description look for a role in the realm
* @param roleName name of the role
*/
let hasRealmRole = KeycloakUtils.Token.hasRealmRole(roleName)

/**
* @description look for role for his name
* @param name of the role
*/
let hasRole = KeycloakUtils.Token.hasRole(name)

License

MIT

keycloak-utils's People

Contributors

mortem45 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.