@reaktor-internal/authorization-client

Authorization Client

This is a client for Reaktor Authorization Service.

Usage

Initialize

    let client = require('authorization-client').client
    //Or for cached version
    client = require('authorization-client').cachedClient
    const myLog = require('my-logger-func')

    client.initialize({
      serviceUrl: 'http://localhost:8080/api/v1/roles',
      authToken: 'dev_auth_token',
      cacheResults: true,
      cacheTTL: TTL_SECS,
      infoLog: myInfoLog,
      errorLog: myErrorLog,
      verboseLog: myVerboseLog
    })

Where:

• serviceUrl url to the reaktor authorization service
• authToken reaktor authorization service auth token
• cacheResults whether or not to cache getAllRoles results (default: false)
• cacheTTL if caching the results how long to store results before retrieving new, as seconds (default: 60)
• infoLog a function to do the info level logging (default: console.log)
• errorLog a function to do the error level logging (default: config.infoLog || console.log)
• verboseLog a function to do the verbose level logging (default: config.verboseLog || console.debug)

getAllRoles

client.getAllRoles().then(res => console.log(JSON.stringify(res)))

{
  "data": {
    "[e-mail]": {
      "roles": ["rex_reaktorian"]
    },
    "[e-mail]": {
      "roles": ["rex_reaktorian", "hours_reaktorian"]
    }
  }
}

if config.cacheResults has been set to true the roles are fetched from cache. If cache does not exist or config.cacheTTL has passed since last fetch then the roles are fetched from the authorization service and the cache is updated. If the authorization service fetch fails the cached results are returned and an error is logged with config.errorLog.

getRoles(authId)

Get roles for authId. Uses internally getAllRoles so the caching rules apply. If there are no roles for the authId the returns _{ roles: []} _.

client.getRoles('does_not_exist').then(res => console.log(JSON.stringify(res)))
{"roles":[]}

addRole(authId, role)

Adds a new role for the given authId. The pair (authId, role) must be unique. If config.cacheResults has been set to true this invalidates the cache and thus causes the roles to be retrieved from the database on next call to getAllRoles.

client.addRole('test_user®reaktor.fi', 'test_user_role').then(console.log)
{
  "data": {
    "[e-mail]": {
      "roles": ["test_user_role"]
    }
  }
}

deleteRoles (authId)

Deletes all the roles for the given auth id. If config.cacheResults has been set to true this invalidates the cache and thus causes the roles to be retrieved from the database on next call to getAllRoles.

client.deleteRoles('test_user®reaktor.fi').then(res => console.log(JSON.stringify(res)))
{
  "data": {
    "[e-mail]": {
      "roles": ["test_user_role"]
    }
  }
}