Skip to main content

auth

auth [url] --provider [okta|splunk|basic] --username [username] --password [password]

Browser authenticate with a supported provider (okta|splunk|basic). The returned values depend on the provider and may include sessionStorage, cookieStorage, localStorage and/or header values.

arguments:

url

The url for the request. (type: string)

examples:

Query

auth [url] --credential [credential]

Query

auth [url]

Query

auth http://localhost:2001 --provider okta --username len --password unsecure

Query

auth http://localhost:2001 --provider splunk --username len --password unsecure"

Query

auth http://localhost:2001 --provider basic --username len --password unsecure"

flags:

--appendStage

Used to append the results from a previous stage to the current stage. (provide a label, stage index, or boolean true to append the previous results)

--cache

A boolean value of true/false that determines whether or not to use the cache. Generally most commands will default to true.

--checkpoint

Format: "{CHECKPOINT NAME}:{COLUMN}" Used to store the value of the provided column (in the first row of results) in the provided name for use as a checkpoint in scheduled queries or other stages. Can be accessed using $CHECKPOINTS.{CHECKPOINT NAME}$

--credential

Provider reference stored in vault (HIGHLY RECOMMENDED). Contains the provider and auth related information.

--enrich

Enriches each result row with the previous row. The previous columns will be appended with a _previous.

--filter

A filter to run on the command results before completing the command. If not provided, no filter is run on the results.

--fresh

Starts the stage as if it was a fresh query, so will not use any previous result.

--guid

Adds a populated random guid column.

--labelStage

Used to label a stage with a user provided label.

--maxConcurrent

Override for the system max concurrent workers for a stage.

--password

Clear text password. NOTE: This is not recommended and use of vault storage HIGHLY recommended.

--provider

Authenticaton provider (okta|splunk|basic). Will peform challenge against specified provider.

--randomizeHash

Randomizes the stage hash, even if args and flags are the same.

--stats

Controls if a stats calculation is run on a stage after it completes.

--table

A comma separated list of columns to include in the command results. If not provided, all columns will be included.

--type

Each command has a default type, either "mapping" or "reducing". Some commands can operate as either, when "reducing" they will operate on all rows at once, when "mapping", they will operate on one row at a time.

--username

Clear text password. NOTE: This is not recommended and use of vault storage HIGHLY recommended.

--while

Will rerun the stage until the provided expression is valid for the first line of results.

support

AMI_ENTERPRISE AMI_FREE AMI_PRO BINARY_ENTERPRISE BINARY_FREE BINARY_PRO DESKTOP_ENTERPRISE DESKTOP_FREE DESKTOP_PRO DOCKER_ENTERPRISE DOCKER_FREE DOCKER_PRO