@postnord/uas-sdk

An SDK to interact with v2 of the User Authority service. Typescript-friendly.

Installation

npm i @postnord/uas-sdk

Usage

import UAS from '@postnord/uas-sdk'
const uasService = new UAS({ isStaging: !!process.env.IS_STAGING })

const run = async () => {
  // Call the getUser function with either an IAM accessToken, a Unified Login token or a JWT already issued by the UAS service

  const user = await uasService.getUser({ accessToken: '' } )
  // OR
  const user = await uasService.getUser({ jwtToken: '' } )
  // OR
  const user = await uasService.getUser({ unifiedLoginToken: '' } )

  if (!user) { /* is not a business user thus does not exist in UAS */ }


  // returns a boolean indicating whether the user has the specified authority on the specified customer number
  user.verifyUserAccess({ authorityNumber: '3', customerNumber: '20137458' }) 

  // verify that the user is a Postnord admin and has the authority specified in the argument
  user.verifyAdminAccess({ authorityNumber: '19' })

  // returns the unflattened view of the token object. See TS types.
  user.getDecodedToken() 

  // returns the full JWT string
  user.getSignedToken() 

  // returns a boolean indicating whether or not the issued JWT is expired
  user.isExpired() 

  // This will call UAS with the returned token to verify the signature
  await user.verifyTokenSignature() 

  // Organization utlity functions

  // returns an organizations object containing organization utility functions 
  const orgs = user.organizations()

  // return true if either of the organizations includes the given authority
  orgs.containAuthority('3')
  // return true if either of the organizations includes atleast one of given authorities
  orgs.containAnyAuthorities(['3','19'])
  // return true if all of the given authorities exists in either of the organizations
  orgs.containAllAuthorities(['3','19'])
}

API documentation

See accompanied types

Feature requests

Hit us up at the #customerportal-user Slack channel