Skip to main content

auth

auth [url]

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.

Type 1 (Manual): auth [url] --provider [okta|splunk|basic] --username [username] --password [password]

Type 2 (Vault): auth [url] --credential [credential]

Type 3 (No Challenge - Headers and [cookie|local|session]Storage ): auth [url]

Okta Auth Example (Unsecure): auth http://localhost:2001 --provider okta --username len --password unsecure"

Splunk Auth Example (Unsecure): auth http://localhost:2001 --provider splunk --username len --password unsecure"

Basic Auth Example (Unsecure): auth http://localhost:2001 --provider basic --username len --password unsecure"

Vault Auth Example - Automatic Provider Inference (Secure): auth http://localhost:2001 --credential 342190rewfafe"

arguments:​

url​

The url for the request. (type: string)

examples:​

Query​

auth [URL] --store [STORE]

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)

--attributes​

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

--cache​

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

--credential​

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

--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.

--labelStage​

Used to label a stage with a user provided label.

--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.

--stats​

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

--username​

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