1.2.5 • Published 3 years ago

@circlesystems/circleauth v1.2.5

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

Circle Auth

Circle Auth - Node.js client for Circle Auth API

Circle Auth allows you to quickly implement userless/passwordless login and 2FA (no more paying for SMS to have 2FA)

We recommend using our Circle Auth Wrapper instead of this module.

Installation

First make sure to get your credentials on Circle Auth Console, if you want to test first, use Circle Auth - Demo

For Node.js

npm

Install it via:

npm install @circlesystems/circleauth --save

Getting Started

Please follow the installation instruction and execute the following JS code:

var circleauth = require('@circlesystems/circleauth');

var api = new circleauth.CircleAuthApi()
var body = new circleauth.Create2FARequest(); // {Create2FARequest} 
var x_ua_appKey = "x_ua_appKey_example"; // {String} Application `appKey`

api.create2FA(body, x_ua_appKey).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://circleauth.gocircle.ai/api

ClassMethodHTTP requestDescription
CircleAuth.CircleAuthApicreate2FAPOST /2fa/create/Create 2FA
CircleAuth.CircleAuthApiexpireUserSessionPOST user/session/expireExpire User Session
CircleAuth.CircleAuthApigetSessionGET /session/Get Session
CircleAuth.CircleAuthApigetUserSessionGET user/sessionGet User Session

Documentation for Models

Distribuition

  1. Update package version at package.json.
  2. Open terminal and run npm publish.
  3. Visit https://www.npmjs.com/package/@circlesystems/circleauth to check latest version.