Class: Aws::STS::Types::GetWebIdentityTokenRequest

Inherits:

Struct

• Object
• Struct
• Aws::STS::Types::GetWebIdentityTokenRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #audience ⇒ Array<String>

  The intended recipient of the web identity token.

• #duration_seconds ⇒ Integer

  The duration, in seconds, for which the JSON Web Token (JWT) will remain valid.

• #signing_algorithm ⇒ String

  The cryptographic algorithm to use for signing the JSON Web Token (JWT).

• #tags ⇒ Array<Types::Tag>

  An optional list of tags to include in the JSON Web Token (JWT).

Instance Attribute Details

#audience ⇒ Array<String>

The intended recipient of the web identity token. This value populates the aud claim in the JWT and should identify the service or application that will validate and use the token. The external service should verify this claim to ensure the token was intended for their use.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1612

class GetWebIdentityTokenRequest < Struct.new(
  :audience,
  :duration_seconds,
  :signing_algorithm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#duration_seconds ⇒ Integer

The duration, in seconds, for which the JSON Web Token (JWT) will remain valid. The value can range from 60 seconds (1 minute) to 3600 seconds (1 hour). If not specified, the default duration is 300 seconds (5 minutes). The token is designed to be short-lived and should be used for proof of identity, then exchanged for credentials or short-lived tokens in the external service.

Returns:

• (Integer)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1612

class GetWebIdentityTokenRequest < Struct.new(
  :audience,
  :duration_seconds,
  :signing_algorithm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#signing_algorithm ⇒ String

The cryptographic algorithm to use for signing the JSON Web Token (JWT). Valid values are RS256 (RSA with SHA-256) and ES384 (ECDSA using P-384 curve with SHA-384).

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1612

class GetWebIdentityTokenRequest < Struct.new(
  :audience,
  :duration_seconds,
  :signing_algorithm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An optional list of tags to include in the JSON Web Token (JWT). These tags are added as custom claims to the JWT and can be used by the downstream service for authorization decisions.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1612

class GetWebIdentityTokenRequest < Struct.new(
  :audience,
  :duration_seconds,
  :signing_algorithm,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end