@datafire/6_dot_authentiqio_appspot - npm Package Compare versions

Comparing version 3.0.0 to 4.0.0

package.json

 {
   "name": "@datafire/6_dot_authentiqio_appspot",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "main": "index.js",
@@ -5,0 +5,0 @@ "description": "DataFire integration for Authentiq",

README.md

@@ -7,18 +7,21 @@ # @datafire/6_dot_authentiqio_appspot
 ```bash
-npm install --save datafire @datafire/6_dot_authentiqio_appspot
+npm install --save @datafire/6_dot_authentiqio_appspot
 ```
-
 ```js
-let datafire = require('datafire');
 let dot_authentiqio_appspot = require('@datafire/6_dot_authentiqio_appspot').create();
 
-dot_authentiqio_appspot.key_revoke_nosecret({}).then(data => {
+dot_authentiqio_appspot.key_revoke_nosecret({
+  "email": "",
+  "phone": ""
+}).then(data => {
   console.log(data);
-})
+});
 ```
 
 ## Description
+
 Strong authentication, without the passwords.
 
 ## Actions
+
 ### key_revoke_nosecret
@@ -40,7 +43,12 @@ Revoke an Authentiq ID using email & phone.
 
-#### 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
+#### Input
+* input `object`
+  * email **required** `string`: primary email associated to Key (ID)
+  * phone **required** `string`: primary phone number, international representation
+  * code `string`: verification code sent by email
 
+#### Output
+* output `object`
+  * status `string`: pending or done
+
 ### key_register
@@ -61,5 +69,11 @@ Register a new ID `JWT(sub, devtoken)`
 
-#### Parameters
-* body (undefined) **required** - Authentiq ID in JWT format, self-signed.
+#### Input
+* input `object`
+  * body **required** [AuthentiqID](#authentiqid)
 
+#### Output
+* output `object`
+  * secret `string`: revoke key
+  * status `string`: registered
+
 ### key_revoke
@@ -76,6 +90,11 @@ Revoke an Identity (Key) with a revocation secret
 
-#### Parameters
-* PK (string) **required** - Public Signing Key - Authentiq ID (43 chars)
-* secret (string) **required** - revokation secret
+#### Input
+* input `object`
+  * PK **required** `string`: Public Signing Key - Authentiq ID (43 chars)
+  * secret **required** `string`: revokation secret
 
+#### Output
+* output `object`
+  * status `string`: done
+
 ### key.PK.get
@@ -92,5 +111,12 @@ Get public details of an Authentiq ID.
 
-#### Parameters
-* PK (string) **required** - Public Signing Key - Authentiq ID (43 chars)
+#### Input
+* input `object`
+  * PK **required** `string`: Public Signing Key - Authentiq ID (43 chars)
 
+#### Output
+* output `object`
+  * since `string`
+  * status `string`
+  * sub `string`: base64safe encoded public signing key
+
 ### key.PK.head
@@ -107,5 +133,9 @@ HEAD info on Authentiq ID
 
-#### Parameters
-* PK (string) **required** - Public Signing Key - Authentiq ID (43 chars)
+#### Input
+* input `object`
+  * PK **required** `string`: Public Signing Key - Authentiq ID (43 chars)
 
+#### Output
+*Output schema unknown*
+
 ### key_update
@@ -129,6 +159,11 @@ update properties of an Authentiq ID.
 
-#### Parameters
-* PK (string) **required** - Public Signing Key - Authentiq ID (43 chars)
-* body (undefined) **required** - Authentiq ID in JWT format, self-signed.
+#### Input
+* input `object`
+  * PK **required** `string`: Public Signing Key - Authentiq ID (43 chars)
+  * body **required** [AuthentiqID](#authentiqid)
 
+#### Output
+* output `object`
+  * status `string`: confirmed
+
 ### key_bind
@@ -153,6 +188,11 @@ Update Authentiq ID by replacing the object.
 
-#### Parameters
-* PK (string) **required** - Public Signing Key - Authentiq ID (43 chars)
-* body (undefined) **required** - Authentiq ID in JWT format, self-signed.
+#### Input
+* input `object`
+  * PK **required** `string`: Public Signing Key - Authentiq ID (43 chars)
+  * body **required** [AuthentiqID](#authentiqid)
 
+#### Output
+* output `object`
+  * status `string`: confirmed
+
 ### push_login_request
@@ -171,6 +211,11 @@ push sign-in request
 
-#### Parameters
-* body (undefined) **required** - PushToken in JWT format, self-signed. 
-* callback (string) **required** - URI App will connect to
+#### Input
+* input `object`
+  * body **required** [PushToken](#pushtoken)
+  * callback **required** `string`: URI App will connect to
 
+#### Output
+* output `object`
+  * status `string`: sent
+
 ### sign_request
@@ -188,6 +233,12 @@ scope verification request
 
-#### Parameters
-* body (undefined) **required** - Claim in JWT format, self- or issuer-signed. 
-* test (integer) - test only mode, using test issuer
+#### Input
+* input `object`
+  * body **required** [Claims](#claims)
+  * test `integer`: test only mode, using test issuer
 
+#### Output
+* output `object`
+  * job `string`: 20-character ID
+  * status `string`: waiting
+
 ### sign_delete
@@ -203,5 +254,10 @@ delete a verification job
 
-#### Parameters
-* job (string) **required** - Job ID (20 chars)
+#### Input
+* input `object`
+  * job **required** `string`: Job ID (20 chars)
 
+#### Output
+* output `object`
+  * status `string`: done
+
 ### sign_retrieve
@@ -217,5 +273,12 @@ get the status / current content of a verification job
 
-#### Parameters
-* job (string) **required** - Job ID (20 chars)
+#### Input
+* input `object`
+  * job **required** `string`: Job ID (20 chars)
 
+#### Output
+* output `object`
+  * exp `integer`
+  * field `string`
+  * sub `string`: base64safe encoded public signing key
+
 ### sign_retrieve_head
@@ -231,5 +294,9 @@ HEAD to get the status of a verification job
 
-#### Parameters
-* job (string) **required** - Job ID (20 chars)
+#### Input
+* input `object`
+  * job **required** `string`: Job ID (20 chars)
 
+#### Output
+*Output schema unknown*
+
 ### sign_confirm
@@ -245,5 +312,10 @@ this is a scope confirmation
 
-#### Parameters
-* job (string) **required** - Job ID (20 chars)
+#### Input
+* input `object`
+  * job **required** `string`: Job ID (20 chars)
 
+#### Output
+* output `object`
+  * status `string`: confirmed
+
 ### sign_update
@@ -261,4 +333,44 @@ authority updates a JWT with its signature
 
-#### Parameters
-* job (string) **required** - Job ID (20 chars)
+#### Input
+* input `object`
+  * job **required** `string`: Job ID (20 chars)
 
+#### Output
+* output `object`
+  * jwt `string`: result is JWT or JSON??
+  * status `string`: ready
+
+
+
+## Definitions
+
+### AuthentiqID
+* AuthentiqID `object`: Authentiq ID in JWT format, self-signed.
+  * devtoken `string`: device token for push messages
+  * sub **required** `string`: UUID and public signing key
+
+### Claims
+* Claims `object`: Claim in JWT format, self- or issuer-signed. 
+  * email `string`
+  * phone `string`
+  * scope **required** `string`: claim scope
+  * sub **required** `string`: UUID
+  * type `string`
+
+### Error
+* Error `object`
+  * detail `string`
+  * error **required** `integer`
+  * title `string`
+  * type `string`: unique uri for this error
+
+### PushToken
+* PushToken `object`: PushToken in JWT format, self-signed. 
+  * aud **required** `string`: audience (URI)
+  * exp `integer`
+  * iat `integer`
+  * iss **required** `string`: issuer (URI)
+  * nbf `integer`
+  * sub **required** `string`: UUID and public signing key
+
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

30377

increased by6.74%

Number of lines in readme file

362

increased by44.8%

No dependency changes