1.0.1 • Published 5 years ago

react-login-apim v1.0.1

Weekly downloads
6
License
MIT
Repository
github
Last release
5 years ago

react-login-apim

React login for Gravitee AM

NPM JavaScript Style Guide

Install

npm install --save react-login-apim

Usage

import React, { Component } from 'react'

import { GraviteeLoginComponent } from 'react-login-apim'
import 'react-login-apim/dist/index.css'

const custom_logout_btn = () => {
  return (
    <div style={{
        padding:10,
        border:'1px solid red',
        width:150, borderRadius:5, color:'red', textAlign:'center', cursor:'pointer'}} > Logout </div>
  )
}

class Example extends Component {
  render() {
    return   <GraviteeLoginComponent

                        customButton={custom_logout_btn}
                        devmode={false}
                        devmode_data={{}}
                        window={window}
                        graviteeserver="<your gravitee server host url>"
                        graviteedomaine="<your gravitee domaine>"
                        clientid="<your gravitee client id>"
                        redirecturl="<the return url after gravitee login on your site>"
                        roles={['<list of expedted role to be checked for the connected user>']}
                        bearer="<Bearer authorization_code >"
                        logoutCallback = {() => {console.log('Logout callback')}}
                        setReceivedToken = {(token) => {
                            setUserToken(token)
                        }}>
      </GraviteeLoginComponent>
  }
}

properties definitions

Propstypecomment
windowrequiredrequired by the module, must be binded to window component
setReceivedTokenrequiredbinded method call to send to the parent the received token
logoutCallbackrequiredbinded method call on logout
graviteeserverrequiredgravitee host url
graviteedomainerequiredgravitee domaine, possible value 'external' or 'internal'
clientidrequiredthe Api client id shrared by gravitee
redirecturlrequiredthe redirect url defined on gravite APIM
rolesoptionalroles to be checked on user loggin
bearerrequiredthe bearer value available on gravitee
devmodeoptionalboolean value to activate the redirect on loading. default value is true to see the logout button
devmode_dataoptionaljson object to return in devmode to simulate the service response combine with devmode=true

License

MIT © Thylou