Skip to main content

oauth

oauth

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.

--auth.tokenHost​

Base URL used to obtain access tokens (required)

--auth.tokenPath​

URL path to obtain access tokens (See url resolution notes). Defaults to /oauth/token

--cache​

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

--client.id​

Service registered client id. When required by the spec this value will be automatically encoded (required).

--client.secret​

Service registered client secret. When required by the spec this value will be automatically encoded (required).

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

--grant​

password|clientcred|authcode

password: Resource Owner Password Credentials Grant The Resource Owner Password Credentials <https://oauth.net/2/grant-types/password/> grant type is a way to exchange a user's credentials for an access token. Because the client application has to collect the user's password and send it to the authorization server, it is not recommended that this grant be used at all anymore.

authcode: Authorization Code Grant The Authorization Code <https://oauth.net/2/grant-types/authorization-code/> grant type is used by confidential and public clients to exchange an authorization code for an access token. After the user returns to the client via the redirect URL, the application will get the authorization code from the URL and use it to request an access token.

clientcred: Client Credentials Grant The Client Credentials <https://oauth.net/2/grant-types/client-credentials/> grant type is used by clients to obtain an access token outside of the context of a user. This is typically used by clients to access resources about themselves rather than to access a user's resources.

--labelStage​

Used to label a stage with a user provided label.

--passwordgrant.password​

User password (required for password grant).

--passwordgrant.username​

User identifier (required for password grant).

--scope​

String or array including a subset of the original client scopes to request.

--stats​

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