bravo-auth-lib v1.0.2

Table of Contents

• listen
  • Parameters
• getAuthorities
  • Parameters
• getAuthoritiesSync
  • Parameters
• setAuthorities
  • Parameters
• getNestedAuthorities
  • Parameters
• hasAuthority
  • Parameters
• hasAuthoritySync
  • Parameters
• getAuthority
  • Parameters
• getAuthoritySync
  • Parameters
• currentUser
  • Parameters
• isValid
  • Parameters
• navigateToValidationUri
  • Parameters
• getToken
  • Parameters
• getTokenOrLeave
  • Parameters
• clientId
• clientSecret
• apiUrl
• rsUrl
• get
  • Parameters
• orElse
  • Parameters
• encrypt
  • Parameters
• decrypt
  • Parameters
• HttpClient
  • Parameters
• get
  • Parameters
• post
  • Parameters
• execRequest
  • Parameters
• handleResponse
  • Parameters
• getURI
  • Parameters
• buildBody
  • Parameters
• basic
  • Parameters
• bearer
  • Parameters
• authority
• description
• id
• name
• email
• employeeId
• client
• authorities
• user_name
• scope
• active
• exp
• authorities
• client_id
• applications

listen

Opens channel and start listening to SSO Events

Parameters

• config {AuthConfig} with SSO configuration

getAuthorities

List current user's authorities (Makes an API call everytime it is invoked)

Parameters

• config {AuthConfig} with SSO configuration

Returns Promise<Array\>

getAuthoritiesSync

List current user's authorities (Uses authorities stored locally)

Parameters

• config {AuthConfig} with SSO configuration

setAuthorities

Loads authorities and stores the locally

Parameters

• config {AuthConfig} with SSO configuration

getNestedAuthorities

List all authorities (Nested)

Parameters

• config {AuthConfig} with SSO configuration

hasAuthority

Validates if the user has the requested authority

Parameters

• config {AuthConfig} with SSO configuration
• authority {string} the requested authority that you want to validate

Returns Promise<boolean>

hasAuthoritySync

Validates if the user has the requested authority (Synced)

Parameters

• config {AuthConfig} with SSO configuration
• authority {string} the requested authority that you want to validate

Returns boolean

getAuthority

Retrieves user authority

Parameters

• config {AuthConfig} with SSO configuration
• authority {string} the requested authority that you want to validate

Returns Promise\

getAuthoritySync

Retrieves user authority (Synced)

Parameters

• config {AuthConfig} with SSO configuration
• authority {string} the requested authority that you want to validate

Returns Authority

currentUser

Retrieves current user User getter, returns the UserInfo if valid session.

Parameters

• config {AuthConfig} with SSO configuration

Returns UserInfo

isValid

Validates if user's token is valid

Parameters

• config {AuthConfig} with SSO configuration

Returns Promise<boolean>

navigateToValidationUri

Navigates to SSO's validation URI

Parameters

• config {AuthConfig} with SSO configuration

getToken

Parameters

• config {AuthConfig} with SSO configuration

Returns (string | undefined)

getTokenOrLeave

Token getter, returns the user-token or redirects to bravo-sso portal if not valid session.

Parameters

• config {AuthConfig} with SSO configuration

clientId

• @type {string}

clientSecret

• @type {string}

apiUrl

• @type {string}

rsUrl

• @type {string}

get

Parameters

• params {any}
• param {AuthParams}
• or {string}

Returns (any | string)

orElse

Parameters

• value {any}
• orElse {T}

Returns (any | T)

encrypt

Used to encode based on a client

Parameters

• clientId {string} the given application id
• value the string param that is being encoded

Returns any string with the resulting encoded value

decrypt

Used to decode based on a client

Parameters

• clientId {string} the given application id
• value the string param that is being decoded

Returns any string with the resulting decoded value

HttpClient

Parameters

• baseUrl {string}

get

Execs http get request

Parameters

• endpoint {string} (optional, default '')
• params {{ [key: string]: any; }} (optional, default {})
• headers {HeadersInit} (optional, default {})

Returns Promise\

post

Execs http post request

Parameters

• endpoint {string} (optional, default '')
• body {any}
• headers {HeadersInit} (optional, default {})
• form {boolean} (optional, default false)

Returns Promise\

execRequest

Execs requests

Parameters

• url
• options

Returns Promise\

handleResponse

Handles and maps response

Parameters

• res

Returns Promise\

getURI

converts object to URI

Parameters

• baseURL {string}
• params { { [key: string]: string | number | undefined } }

Returns string

buildBody

Parameters

• data
• type ('FORM_DATA' | 'JSON') (optional, default 'FORM_DATA')

Returns (FormData | any)

basic

Builds authentication header for basic-authentication.

Parameters

• config the given application id

Returns any HttpHeaders with the requested header

bearer

Builds authentication header for bearer-token-authentication.

Parameters

• token the token used for the authentication header, default this.token

Returns any HttpHeaders with the requested header

authority

• @type {string}

description

• @type {string}

id

• @type {string}

name

• @type {string}

email

• @type {string}

employeeId

• @type {string}

client

• @type {string}

authorities

• @type {Array}

user_name

• @type {string}

scope

• @type {string[]}

active

• @type {boolean}

exp

• @type {number}

authorities

• @type {string []}

client_id

• @type {string}

applications

• @type {Application[]}