Class: Aws::Signin::Types::IntrospectOAuth2TokenWithIAMResponse

Inherits:

Struct

• Object
• Struct
• Aws::Signin::Types::IntrospectOAuth2TokenWithIAMResponse

Defined in:

gems/aws-sdk-core/lib/aws-sdk-signin/types.rb

Overview

Output structure for IntrospectOAuth2TokenWithIAM operation

RFC 7662 §2.2 introspection response. Only active is required; all other claims are omitted when the token is inactive.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

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

• #active ⇒ Boolean

  Indicates whether the token is currently active.

• #aud ⇒ String

  The OAuth resource the token is scoped to.

• #client_id ⇒ String

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

• #exp ⇒ Integer

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

• #iat ⇒ Integer

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

• #iss ⇒ String

  Issuer of the token.

• #jti ⇒ String

  Unique identifier for the token.

• #nbf ⇒ Integer

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

• #resource ⇒ String

  The OAuth resource the token is scoped to.

• #signin_session ⇒ String

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

• #sub ⇒ String

  The IAM principal Amazon Resource Name (ARN).

• #token_type ⇒ String

  Indicates which kind of token was introspected.

• #user_id ⇒ String

  User identifier matching the "UserId" field from "sts:GetCallerIdentity" for the token's subject principal.

Instance Attribute Details

#account_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#active ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#aud ⇒ String

The OAuth resource the token is scoped to. Omitted for refresh tokens. Example: "aws-mcp.amazonaws.com".

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#client_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#exp ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#iat ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#iss ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#jti ⇒ String

Unique identifier for the token.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#nbf ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#resource ⇒ String

The OAuth resource the token is scoped to. Only present for refresh token introspection.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#signin_session ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#sub ⇒ String

The IAM principal Amazon Resource Name (ARN). For assumed-role sessions, this is the session ARN.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#token_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

User identifier matching the "UserId" field from "sts:GetCallerIdentity" for the token's subject principal.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 586

class IntrospectOAuth2TokenWithIAMResponse < Struct.new(
  :active,
  :client_id,
  :user_id,
  :token_type,
  :exp,
  :iat,
  :nbf,
  :sub,
  :aud,
  :iss,
  :jti,
  :account_id,
  :signin_session,
  :resource)
  SENSITIVE = []
  include Aws::Structure
end