AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . signin ]

create-o-auth2-token

Description

CreateOAuth2Token API

Path: /v1/token Request Method: POST Content-Type: application/json or application/x-www-form-urlencoded

This API implements OAuth 2.0 flows for AWS Sign-In CLI clients, supporting both:

  • Authorization code redemption (grant_type=authorization_code) - NOT idempotent
  • Token refresh (grant_type=refresh_token) - Idempotent within token validity window

The operation behavior is determined by the grant_type parameter in the request body:

Authorization Code Flow (NOT Idempotent):

  • JSON or form-encoded body with client_id, grant_type=authorization_code, code, redirect_uri, code_verifier
  • Returns access_token, token_type, expires_in, refresh_token, and id_token
  • Each authorization code can only be used ONCE for security (prevents replay attacks)

Token Refresh Flow (Idempotent):

  • JSON or form-encoded body with client_id, grant_type=refresh_token, refresh_token
  • Returns access_token, token_type, expires_in, and refresh_token (no id_token)
  • Multiple calls with same refresh_token return consistent results within validity window

Authentication and authorization:

  • Confidential clients: sigv4 signing required with signin:ExchangeToken permissions
  • CLI clients (public): authn/authz skipped based on client_id & grant_type

Note: This operation cannot be marked as @idempotent because it handles both idempotent (token refresh) and non-idempotent (auth code redemption) flows in a single endpoint.

See also: AWS API Documentation

Synopsis

  create-o-auth2-token
--token-input <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--token-input (structure)

Flattened token operation inputs The specific operation is determined by grant_type in the request body

clientId -> (string)

The client identifier (ARN) used during Sign-In onboarding Required for both authorization code and refresh token flows

grantType -> (string)

OAuth 2.0 grant type - determines which flow is used Must be “authorization_code” or “refresh_token”

code -> (string)

The authorization code received from /v1/authorize Required only when grant_type=authorization_code

redirectUri -> (string)

The redirect URI that must match the original authorization request Required only when grant_type=authorization_code

codeVerifier -> (string)

PKCE code verifier to prove possession of the original code challenge Required only when grant_type=authorization_code

refreshToken -> (string)

The refresh token returned from auth_code redemption Required only when grant_type=refresh_token

Shorthand Syntax:

clientId=string,grantType=string,code=string,redirectUri=string,codeVerifier=string,refreshToken=string

JSON Syntax:

{
  "clientId": "string",
  "grantType": "string",
  "code": "string",
  "redirectUri": "string",
  "codeVerifier": "string",
  "refreshToken": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

tokenOutput -> (structure)

Flattened token operation outputs The specific response fields depend on the grant_type used in the request

accessToken -> (structure)

Scoped-down AWS credentials (15 minute duration) Present for both authorization code redemption and token refresh

accessKeyId -> (string)

AWS access key ID for temporary credentials

secretAccessKey -> (string)

AWS secret access key for temporary credentials

sessionToken -> (string)

AWS session token for temporary credentials

tokenType -> (string)

Token type indicating this is AWS SigV4 credentials Value is “aws_sigv4” for both flows

expiresIn -> (integer)

Time to expiry in seconds (maximum 900) Present for both authorization code redemption and token refresh

refreshToken -> (string)

Encrypted refresh token with cnf.jkt (SHA-256 thumbprint of presented jwk) Always present in responses (required for both flows)

idToken -> (string)

ID token containing user identity information Present only in authorization code redemption response (grant_type=authorization_code) Not included in token refresh responses