README
@al/aims
A client for working with the AIMS Alert Logic API.
This library uses @al/client as its HTTP provider interface.
Disclaimer
Until the release of version 1.0.0 all current minor version increments may be backwards incompatible. Please bear this in mind when developing against this library. Should you have any further questions, please do not hesitate to contact us as npm@alertlogic.com
Installation
npm install @al/aims --save
Usage
var AIMSClient = require('@al/aims').AIMSClient; //commonjs - e.g. node
import { AIMSClient } from '@al/aims'; //ES2015 - e.g. Angular, TS projects
Get Account Details
AIMSClient.getAccountDetails(accountId)
accountId: '1234'
Get Managed Accounts
AIMSClient.getManagedAccounts(accountId, queryParams)
accountId: '1234'
queryParams: {
active: true,
relationship: 'bills_to|managed|managing'
}
Enbale or disabled MFA requirement on account
AIMSClient.requireMFA(accountId, bool)
accountId: '1234',
bool: true|false
Authenticate a user
AIMSClient.authenticate(params, username, password, mfa_code);
params: {
service_name: 'aims',
path: '/authenticate'
},
username: 'bob@email.com',
password: 'IAmNotAValidUser!@#