AWS CLI Command Reference

[ aws . signin ]

introspect-oauth2-token-with-iam

Description

Grants permission to inspect the metadata and state of an OAuth 2.0 access token or refresh token

Implements RFC 7662 OAuth 2.0 Token Introspection over a SigV4-authenticated endpoint. Inspects the metadata of an access_token or refresh_token issued by AWS Sign-In and returns the claims associated with it.

Inactive token semantics (RFC 7662 §2.2): when the supplied token is unknown, expired, revoked, malformed, or owned by a different account, the response body is exactly { “active”: false } with all other claims omitted.

See also: AWS API Documentation

Synopsis

  introspect-oauth2-token-with-iam
--token <value>
[--token-type-hint <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--token (string) [required]

The string value of the token to introspect. May be either an access_token or a refresh_token issued by AWS Sign-In.

Constraints:

  • min: 1
  • max: 4096
  • pattern: ASO[AR][A-Za-z0-9+/=_\-]+

--token-type-hint (string)

Optional hint about the type of the token submitted for introspection. The server uses this hint to optimize lookup, but still falls back to the other token type on miss. Allowed values: access_token, refresh_token.

Constraints:

  • pattern: (access_token|refresh_token)

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream
  • off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

active -> (boolean)

Indicates whether the token is currently active. true only when the token is valid, has not expired, has not been revoked, and belongs to the caller’s account.

clientId -> (string)

Client identifier for the OAuth 2.0 client that requested the token.

userId -> (string)

User identifier matching sts:GetCallerIdentity’s UserId field for the token’s subject principal (e.g. “AIDAEXAMPLE” for an IAM user, or “AROAEXAMPLE:session-name” for an assumed role).

tokenType -> (string)

Indicates which kind of token was introspected. One of “access_token” or “refresh_token”.

Constraints:

  • pattern: (access_token|refresh_token)

exp -> (long)

Token expiration time as a NumericDate (Unix epoch seconds).

iat -> (long)

Token issuance time as a NumericDate (Unix epoch seconds).

nbf -> (long)

Token “not before” time as a NumericDate (Unix epoch seconds).

sub -> (string)

Subject of the token: the IAM principal ARN. For assumed-role sessions, this is the session ARN (matches sts:GetCallerIdentity’s Arn field), e.g. arn:aws:sts::123456789012:assumed-role/MyRole/session-name.

aud -> (string)

Audience of the token: the OAuth resource the token is scoped to (for example, “aws-mcp.amazonaws.com”). Omitted for refresh tokens.

iss -> (string)

Issuer of the token. Always “signin.amazonaws.com” for AWS Sign-In.

jti -> (string)

Unique identifier for the token.

accountId -> (string)

12-digit AWS account ID of the token’s subject principal.

Constraints:

  • min: 12
  • max: 12
  • pattern: [0-9]{12}

signinSession -> (string)

AWS Sign-In session ARN bound to the token, of the form arn:aws:signin:{region}:{account}:session/{uuid}.

resource -> (string)

The OAuth resource the token is scoped to during Human OAuth flow. Only present for refresh token introspection.
© Copyright 2026, Amazon Web Services. Created using Sphinx.