@datafire/6_dot_authentiqio_appspot

@datafire/6_dot_authentiqio_appspot

Client library for Authentiq

Installation and Usage

npm install --save datafire @datafire/6_dot_authentiqio_appspot

let datafire = require('datafire');
let 6_dot_authentiqio_appspot = require('@datafire/6_dot_authentiqio_appspot').actions;
let context = new datafire.Context();

6_dot_authentiqio_appspot.key.delete({}, context).then(data => {
  console.log(data);
})

Description

Actions

key.delete

Revoke an Authentiq ID using email & phone.

If called with email and phone only, a verification code will be sent by email. Do a second call adding code to complete the revocation.

6_dot_authentiqio_appspot.key.delete({
  "email": "",
  "phone": ""
}, context)

Parameters

• email (string) required - primary email associated to Key (ID)
• phone (string) required - primary phone number, international representation
• code (string) - verification code sent by email

key.post

Register a new ID JWT(sub, devtoken)

v5: JWT(sub, pk, devtoken, ...)

See: https://github.com/skion/authentiq/wiki/JWT-Examples

6_dot_authentiqio_appspot.key.post({
  "body": null
}, context)

Parameters

• body (undefined) required - Authentiq ID in JWT format, self-signed.

key.PK.delete

Revoke an Identity (Key) with a revocation secret

6_dot_authentiqio_appspot.key.PK.delete({
  "PK": "",
  "secret": ""
}, context)

Parameters

• PK (string) required - Public Signing Key - Authentiq ID (43 chars)
• secret (string) required - revokation secret

key.PK.get

Get public details of an Authentiq ID.

6_dot_authentiqio_appspot.key.PK.get({
  "PK": ""
}, context)

Parameters

• PK (string) required - Public Signing Key - Authentiq ID (43 chars)

key.PK.head

HEAD info on Authentiq ID

6_dot_authentiqio_appspot.key.PK.head({
  "PK": ""
}, context)

Parameters

• PK (string) required - Public Signing Key - Authentiq ID (43 chars)

key.PK.post

update properties of an Authentiq ID. (not operational in v4; use PUT for now)

v5: POST issuer-signed email & phone scopes in a self-signed JWT

See: https://github.com/skion/authentiq/wiki/JWT-Examples

6_dot_authentiqio_appspot.key.PK.post({
  "PK": "",
  "body": null
}, context)

Parameters

• PK (string) required - Public Signing Key - Authentiq ID (43 chars)
• body (undefined) required - Authentiq ID in JWT format, self-signed.

key.PK.put

Update Authentiq ID by replacing the object.

v4: JWT(sub,email,phone) to bind email/phone hash;

v5: POST issuer-signed email & phone scopes and PUT to update registration JWT(sub, pk, devtoken, ...)

See: https://github.com/skion/authentiq/wiki/JWT-Examples

6_dot_authentiqio_appspot.key.PK.put({
  "PK": "",
  "body": null
}, context)

Parameters

• PK (string) required - Public Signing Key - Authentiq ID (43 chars)
• body (undefined) required - Authentiq ID in JWT format, self-signed.

login.post

push sign-in request See: https://github.com/skion/authentiq/wiki/JWT-Examples

6_dot_authentiqio_appspot.login.post({
  "body": null,
  "callback": ""
}, context)

Parameters

• body (undefined) required - PushToken in JWT format, self-signed.
• callback (string) required - URI App will connect to

scope.post

scope verification request See: https://github.com/skion/authentiq/wiki/JWT-Examples

6_dot_authentiqio_appspot.scope.post({
  "body": null
}, context)

Parameters

• body (undefined) required - Claim in JWT format, self- or issuer-signed.
• test (integer) - test only mode, using test issuer

scope.job.delete

delete a verification job

6_dot_authentiqio_appspot.scope.job.delete({
  "job": ""
}, context)

Parameters

• job (string) required - Job ID (20 chars)

scope.job.get

get the status / current content of a verification job

6_dot_authentiqio_appspot.scope.job.get({
  "job": ""
}, context)

Parameters

• job (string) required - Job ID (20 chars)

scope.job.head

HEAD to get the status of a verification job

6_dot_authentiqio_appspot.scope.job.head({
  "job": ""
}, context)

Parameters

• job (string) required - Job ID (20 chars)

scope.job.post

this is a scope confirmation

6_dot_authentiqio_appspot.scope.job.post({
  "job": ""
}, context)

Parameters

• job (string) required - Job ID (20 chars)

scope.job.put

authority updates a JWT with its signature See: https://github.com/skion/authentiq/wiki/JWT-Examples

6_dot_authentiqio_appspot.scope.job.put({
  "job": ""
}, context)

Parameters

• job (string) required - Job ID (20 chars)