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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
-
#scope ⇒ String
One or more OAuth 2.0 scope values to include in the JSON Web Token (JWT).
-
#signing_algorithm ⇒ String
The cryptographic algorithm to use for signing the JSON Web Token (JWT).
-
#subject_mode ⇒ String
Specifies which identity STS puts in the
sub(subject) claim of 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.
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1890 class GetWebIdentityTokenRequest < Struct.new( :audience, :duration_seconds, :signing_algorithm, :scope, :subject_mode, :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.
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1890 class GetWebIdentityTokenRequest < Struct.new( :audience, :duration_seconds, :signing_algorithm, :scope, :subject_mode, :tags) SENSITIVE = [] include Aws::Structure end |
#scope ⇒ String
One or more OAuth 2.0 scope values to include in the JSON Web Token
(JWT). Amazon Web Services STS copies the value exactly as you send
it into the top-level scope claim of the token. If you don't
specify Scope, the token doesn't include a scope claim.
Separate multiple values with a single space, as defined in RFC
6749, section 3.3 on the IETF website. Don't begin or end
Scope with a space. Each scope value can contain printable ASCII
characters except spaces, double quotation marks ("), commas
(,), and backslashes (``).
You can't repeat a scope value. Scope values are case sensitive.
This means that read and READ are separate values.
You can specify Scope only when SubjectMode is OriginIdentity
and you request exactly one audience. To specify Scope, the
calling principal must have permission for the
sts:SetWebIdentityTokenScope action in addition to
sts:GetWebIdentityToken. You can use the multivalued
sts:IdentityTokenScope condition key in a policy to control which
scope values a principal can request.
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1890 class GetWebIdentityTokenRequest < Struct.new( :audience, :duration_seconds, :signing_algorithm, :scope, :subject_mode, :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).
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1890 class GetWebIdentityTokenRequest < Struct.new( :audience, :duration_seconds, :signing_algorithm, :scope, :subject_mode, :tags) SENSITIVE = [] include Aws::Structure end |
#subject_mode ⇒ String
Specifies which identity STS puts in the sub (subject) claim of
the JSON Web Token (JWT). Valid values are AWSIdentity and
OriginIdentity. If you don't specify a value, Amazon Web Services
STS uses AWSIdentity.
AWSIdentity– Thesubclaim contains the ARN of the calling Amazon Web Services principal.OriginIdentity– Thesubclaim contains the value of theaws:OriginIdentity/Subjectkey in the trusted identity propagation context of the calling session. For example, this can identify the human user or workload on whose behalf the calling session acts. Amazon Web Services STS also adds asubject_modeclaim to the token.To use
OriginIdentity, the trusted identity propagation context of the calling session must contain theaws:OriginIdentity/Subjectkey and either theaws:OriginIdentity/Issuerkey or theaws:OriginIdentity/FederatedProviderArnkey. If it doesn't, or if the subject is blank, Amazon Web Services STS rejects the request with a validation error.Amazon Web Services STS denies the request if the subject begins with the text
arn:, in any combination of uppercase and lowercase letters. Amazon Web Services STS also denies the request if the subject begins or ends with a space, or contains a control, format, or separator character other than a space.
You can use the sts:SubjectMode condition key in a policy to
control which subject modes a principal can request.
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1890 class GetWebIdentityTokenRequest < Struct.new( :audience, :duration_seconds, :signing_algorithm, :scope, :subject_mode, :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.
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 1890 class GetWebIdentityTokenRequest < Struct.new( :audience, :duration_seconds, :signing_algorithm, :scope, :subject_mode, :tags) SENSITIVE = [] include Aws::Structure end |