Skip to content

Commit

Permalink
update package refs to use new @al scope
Browse files Browse the repository at this point in the history
  • Loading branch information
parky128 committed Feb 13, 2019
1 parent 523e6b5 commit 7c08586
Show file tree
Hide file tree
Showing 3 changed files with 111 additions and 321 deletions.
130 changes: 6 additions & 124 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,141 +1,23 @@
@alertlogic/aims
@al/cargo
=========

A client for working with the AIMS Alert Logic API.
A client for working with the Cargo Alert Logic API.

This library uses @alertlogic/client as its HTTP provider interface.
This library uses @al/cargo 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 [[email protected]](mailto:[email protected])

## Installation

npm install @alertlogic/aims --save
npm install @al/cargo --save

## Usage

var AIMSClient = require('@alertlogic/aims').AIMSClient; //commonjs - e.g. node
import { AIMSClient } from '@alertlogic/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: '[email protected]',
password: 'IAmNotAValidUser!@#$',
mfa_code: '123456'

Change a users password

AIMSClient.changePassword(email, password, newPassword)
email: '[email protected]',
password: IAmNotAValidUser!@#$',
newPassword: 'ANewPasswordOfMyChoosing'

Reconstitute a logged in users identity from their AIMS Token

AIMClient.tokenInfo()

Initiate a password reset

AIMSClient.initiateReset(email, returnTo)
email: '[email protected]'',
returnTo: 'https://URLForLoginPurposes'

Complete a password reset

AIMSClient.resetWithToken(token, password)
token: 'ProvidedInEmail',
password: 'ANewPasswordOfMyChoosing'

Create a role

AIMSClient.createRole(accountId, name, permissions)
accountId: '1234',
name: 'This Is My New Role',
permissions: '{"*:own:*:*": "allowed", "aims:own:grant:*":"allowed"}'

Delete a role

AIMSClient.deleteRole(accountId, roleId)
accountId: '1234',
roleId: 'UUID-GOES-HERE'

Get Global Role

AIMSClient.getGlobalRole(roleId)
roleId: 'UUID-GOES-HERE'

Get Account Role

AIMSClient.getAccountRole(accountId, roleId)
accountId: '1234',
roleId: 'UUID-GOES-HERE'

Get all Global Roles

AIMSClient.getGlobalRoles()

Get all Account Roles

AIMSClient.getAccountRoles(accountId)
accountId: '1234'

Update a Role

AIMSClient.updateRole(accountId, name, permissions)
accountId: '1234',
name: 'The New Role Name',
permissions: '{"*:own:*:*": "allowed", "aims:own:grant:*":"allowed"}'

Update a Role Name

AIMSClient.updateRole(accountId, name)
accountId: '1234',
name: 'The New Role Name',

Update Role Permissions

AIMSClient.updateRole(accountId, permissions)
accountId: '1234',
permissions: '{"*:own:*:*": "allowed", "aims:own:grant:*":"allowed"}'

Enroll a Users MFA Device

AIMSClient.enrollMFA(uri, codes)
uri: 'otpauth://totp/Alert%20Logic:[email protected]?secret=GFZSA5CINFJSA4ZTNNZDG5BAKM2EMMZ7&issuer=Alert%20Logic&algorithm=SHA1',
codes: ["123456", "456789"]

Remove a Users MFA Device

AIMSClient.deleteMFA(email)
email: '[email protected]'
var CargoClient = require('@al/cargo').CargoClient; //commonjs - e.g. node
import { CargoClient } from '@al/cargo'; //ES2015 - e.g. Angular, TS projects

## Interactive

Loads the library into memory and stays in an interactive node shell.
Expand Down
Loading

0 comments on commit 7c08586

Please sign in to comment.