@blinkmobile/bm-identity

bm-identity.js

Provides easy management of authenication for our CLI via a single identity.

Getting Started

npm install @blinkmobile/bm-identity --save

const pkg = require('./package.json');
const BlinkMobileIdentity = require('@blinkmobile/bm-identity');
const blinkMobileIdentity = new BlinkMobileIdentity(pkg.name);

Usage

Login

If no LoginOptions are passed, a browser based login process will start. This is how users can login using a social account e.g. Google.

login (options: LoginOptions) => Promise{String}

interface LoginOptions {
  username? : String|Boolean, // Can also pass true, and username will be prompted for
  password? : String, // Will be prompted for password if username is truthy
  email? : String|Boolean, // Can also pass true to be prompted for email address
  sms? : String|Boolean, // Can also pass true to be prompted for phone number
  storeJwt? : Boolean, // Set to true to store jwt on local file system, defaults to false
}

blinkMobileIdentity.login()
  .then(jwt => {
    // Use jwt access token.
  });

storeJwt Option

• If set to true, will use @blinkmobile/blinkmrc User Config to store on local file system for later use.

Logout

logout () => Promise

blinkMobileIdentity.logout();

Assume AWS Role

assumeAWSRole (additionalParameters: Object) => Promise{AssumedRoleCredentials}

interface AssumedRoleCredentials {
  accessKeyId : String,
  secretAccessKey : String,
  sessionToken : String
}

blinkMobileIdentity.assumeAWSRole()
  .then(credentials => {
    // Use AWS credentials
  });

Get Profile

If accessToken is not passed, will attempt to get the access token from the file system.

See Auth0 Profile Structure for available properties.

getProfile (accessToken: String | undefined) => Promise{Auth0Profile}

blinkMobileIdentity.getProfile()
  .then(profile => {
    // Use Auth0 profile
  });

Get Access Token

To create an AccessToken using BlinkM Deployment Keys or retrieve the AccessToken stored after a successful login:

Using Deployment Keys

If the following environment variables are set:

• BLINKM_ACCESS_KEY
• BLINKM_SECRET_KEY

These will be used to create an AccessToken

getAccessToken () => Promise{string}

blinkMobileIdentity.getAccessToken()
  .then(jwt => {
    // Use access token
  });

Manage Tenants

Get and set the current tenant. Also get and remove list of previously used tenants.

getTenants () => Promise{Tenants}

setTenant (tenantName: String) => Promise{Tenants}

removeTenant (tenantName: String) => Promise{Tenants}

interface Tenants {
  current : String,
  previous : Array{String}
}

blinkMobileIdentity.getTenants()
  .then(tenants => {
    // Use tenants
  });

blinkMobileIdentity.setTenant('TenantName')
  .then(tenants => {
    // Tenant was set
  });

blinkMobileIdentity.removeTenant('TenantName')
  .then(tenants => {
    // Tenant was removed
  });

Changelog

3.2.0 - 2018-01-10

Added

• API-116: check for environment variables to use to create JWT instead of checking local file system.

Dependencies

• update inquirer to 5.0.0 (from 3.3.0)