@take2identity/verosint 0.2.136 → 0.2.137

package/README.md

@@ -16,8 +16,9 @@
 Use the `verosint` tool to:
 
 * Send events to the SignalPrint endpoint to create a map of identities and access history.
+* Evaluate workflows (formerly known as rule sets) one by one or in bulk.
 * Generate an [LDAP Schema](https://www.rfc-editor.org/rfc/rfc4512#page-22)
-file to store rules evaluation atttributes in user entries.
+file to store workflow evaluation atttributes in user entries.
 
 Download the binary from:
 [releases page](https://gitlab.com/verosint/public/verosint/-/releases).
@@ -92,7 +93,7 @@ verosint evaluate rules-batch --help
 
 The tool can read settings from a configuration file in a
 [YAML](https://yaml.org/) format.
-For example, you can store the API key as well as rules inside the file.
+For example, you can store the API key as well as workflows inside the file.
 
 By default, the tool looks for the configuration file `.verosint.yaml` in
 your home directory. You can override this setting with the
@@ -125,7 +126,7 @@ verosint evaluate evaluate rule phone:15123944240 --ruleSetUuid 4f5ab21b-984c-45
 When using commands involving an account ID you should
 wrap the identifier in double quotes.
 
-### Evaluating Rules
+### Evaluating Workflows
 
 #### Single Set of Identifiers
 
@@ -154,44 +155,44 @@ Responses are provided in the JSON format on the standard output.
 
 ##### Examples
 
-###### 2. Evaluate an IPv6 address, a phone number and an email address for a Rule Set
+###### 2. Evaluate an IPv6 address, a phone number and an email address for a Workflow
 
 ```shell
 verosint evalute rule ip:2607:fb91:1296:c7dc:a0c4:25a9:ac7a:4384 email:user@example.com phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
 
 ```
 
-###### 3. Evaluate an IPv4 for address against a rule set already defined in the configuration
+###### 3. Evaluate an IPv4 for address against a workflow already defined in the configuration
 
-To obtain the UUID of the rule set, visit the
-[Rules](https://app.verosint.com/rules) configuration and copy the UUID of
-the rule set you would like to evaluate.
+To obtain the UUID of the workflow, visit the
+[Workflows](https://app.verosint.com/workflows) configuration and copy the UUID of
+the workflow you would like to evaluate.
 
-![Copy Rule Set UUID](https://gitlab.com/verosint/public/verosint/-/raw/main/assets/copyrulesetuuid.png)
+![Copy Workflow UUID](https://gitlab.com/verosint/public/verosint/-/raw/main/assets/copyworkflowuuid.png)
 
 ```shell
 verosint evalute rule ip:104.255.6.45 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
 ```
 
-###### 4. Evaluate an Email address against a rule set provided using a local file
+###### 4. Evaluate an Email address against a workflow provided using a local file
 
-You can export a rule set defined in the [Rules](https://app.verosint.com/rules)
+You can export a workflow defined in the [Workflows](https://app.verosint.com/workflows)
 configuration into a local file as shown below.
 
-![Export Rule Set](https://gitlab.com/verosint/public/verosint/-/raw/main/assets/exportruleset.png)
+![Export Workflow](https://gitlab.com/verosint/public/verosint/-/raw/main/assets/exportworkflow.png)
 
 This example evaluates the `babs@jensen.com` email address against the rule defined
-in the `mfarule.json` file.
+in the `mfaworkflow.json` file.
 
 ```shell
-verosint evaluate rule email:babs@jensen.com --ruleSetFile mfarule.json
+verosint evaluate rule email:babs@jensen.com --ruleSetFile mfaworkflow.json
 ```
 
-##### 5. Check if an IP address is within 100 kilometers of Austin, TX using a local rule set
+##### 5. Check if an IP address is within 100 kilometers of Austin, TX using a local workflow
 
-You can place rules inside a local configuration file. The following is
+You can place a workflow inside a local configuration file. The following is
 an example file that uses the `isWithin` function, which enables you to
-create rules for [geo-fencing](https://en.wikipedia.org/wiki/Geo-fence)
+create a workflow for [geo-fencing](https://en.wikipedia.org/wiki/Geo-fence)
 purposes:
 
 ```yaml
@@ -204,7 +205,7 @@ rules:
       reason: This IP is not within 100 kilometers of Austin, Texas
 ```
 
-The following example runs the same rule saved in the default
+The following example runs the same workflow saved in the default
 configuration file against the `104.16.44.99` IP address:
 
 ```shell
@@ -213,7 +214,7 @@ verosint evaluate rules ip:104.16.44.99
 
 #### Batch Evaluation
 
-Use input files to evaluate multiple sets of identifiers against rules.
+Use input files to evaluate multiple sets of identifiers against workflows.
 Batch commands can use input and output files in CSV or
 LDIF format, and can produce a report file formatted as JSON.
 
@@ -222,7 +223,7 @@ single set of identifiers.
 
 ##### Batch Evaluation Examples
 
-###### 2. Executing Batch Rules Evaluation with column index and LDIF output
+###### 2. Executing Batch Workflow Evaluation with column index and LDIF output
 
 If using an input file that has multiple identifiers, you can provide a
 column index (where 0 refers to the first column) to indicate where the
@@ -234,7 +235,7 @@ ipaddress,mail,telephone
 104.16.44.99,babs@jensen.com,15123944240
 ```
 
-Using the rules present in the default configuration file, the
+Using the workflows present in the default configuration file, the
 following command generates LDIF-formatted output and JSON report
 files:
 
@@ -249,12 +250,12 @@ verosint evaluate rules-batch ip:0 email:1 phone:2 \
 
 You can submit events to the SignalPrint endpoint using the
 `signalprint send-events` subcommand. This subcommand works like the
-batch commands for rules. An IP address, a user agent, and an event
+batch commands for workflows. An IP address, a user agent, and an event
 type are required for each event. You can optionally submit an
 event timestamp, an account identifier, an email address, and
 a phone number as well.
 
-The timestamp is expected to be in [RFC3339](https://www.rfc-editor.org/rfc/rfc3339) or [UNIX](https://www.unixtimestamp.com/) format. 
+The timestamp is expected to be in [RFC3339](https://www.rfc-editor.org/rfc/rfc3339) or [UNIX](https://www.unixtimestamp.com/) format.
 
 For example:
 
@@ -319,7 +320,7 @@ verosint signalprint send-events --inputFile events.csv
 ### Generating LDAP Schema
 
 This command prints an LDAP schema that allows you to enrich existing
-user entries in your directory with rule evaluation data from
+user entries in your directory with workflow evaluation data from
 the API. The enterprise number (59592) in the object identifiers (OIDs)
 is registered with the
 [Internet Assigned Numbers Authority](https://www.iana.org/assignments/enterprise-numbers/).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@take2identity/verosint",
-  "version": "0.2.136",
+  "version": "0.2.137",
   "description": "Official CLI to interact with Verosint API",
   "main": "index.js",
   "scripts": {
@@ -27,9 +27,9 @@
   ],
   "homepage": "https://gitlab.com/verosint/public/verosint#readme",
   "dependencies": {
-    "axios": "^1.3.4",
+    "axios": "^1.7.8",
     "mkdirp": "^3.0.1",
-    "tar": "^6.1.13",
-    "unzipper": "0.12.3"
+    "tar": "^7.4.3",
+    "unzipper": "^0.12.3"
   }
 }