Class GetWebIdentityTokenRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetWebIdentityTokenRequest.Builder,GetWebIdentityTokenRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionaudience()The intended recipient of the web identity token.builder()final IntegerThe duration, in seconds, for which the JSON Web Token (JWT) will remain valid.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final booleanFor responses, this returns true if the service returned a value for the Audience property.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final Stringscope()One or more OAuth 2.0 scope values to include in the JSON Web Token (JWT).static Class<? extends GetWebIdentityTokenRequest.Builder> final StringThe cryptographic algorithm to use for signing the JSON Web Token (JWT).Specifies which identity STS puts in thesub(subject) claim of the JSON Web Token (JWT).final StringSpecifies which identity STS puts in thesub(subject) claim of the JSON Web Token (JWT).tags()An optional list of tags to include in the JSON Web Token (JWT).Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasAudience
public final boolean hasAudience()For responses, this returns true if the service returned a value for the Audience property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
audience
The intended recipient of the web identity token. This value populates the
audclaim 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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAudience()method.- Returns:
- The intended recipient of the web identity token. This value populates the
audclaim 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.
-
durationSeconds
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:
- 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.
-
signingAlgorithm
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:
- 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).
-
scope
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
scopeclaim of the token. If you don't specifyScope, the token doesn't include ascopeclaim.Separate multiple values with a single space, as defined in RFC 6749, section 3.3 on the IETF website. Don't begin or end
Scopewith 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
readandREADare separate values.You can specify
Scopeonly whenSubjectModeisOriginIdentityand you request exactly one audience. To specifyScope, the calling principal must have permission for thests:SetWebIdentityTokenScopeaction in addition tosts:GetWebIdentityToken. You can use the multivaluedsts:IdentityTokenScopecondition key in a policy to control which scope values a principal can request.- Returns:
- 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
scopeclaim of the token. If you don't specifyScope, the token doesn't include ascopeclaim.Separate multiple values with a single space, as defined in RFC 6749, section 3.3 on the IETF website. Don't begin or end
Scopewith 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
readandREADare separate values.You can specify
Scopeonly whenSubjectModeisOriginIdentityand you request exactly one audience. To specifyScope, the calling principal must have permission for thests:SetWebIdentityTokenScopeaction in addition tosts:GetWebIdentityToken. You can use the multivaluedsts:IdentityTokenScopecondition key in a policy to control which scope values a principal can request.
-
subjectMode
Specifies which identity STS puts in the
sub(subject) claim of the JSON Web Token (JWT). Valid values areAWSIdentityandOriginIdentity. If you don't specify a value, Amazon Web Services STS usesAWSIdentity.-
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:SubjectModecondition key in a policy to control which subject modes a principal can request.If the service returns an enum value that is not available in the current SDK version,
subjectModewill returnWebIdentityTokenSubjectModeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsubjectModeAsString().- Returns:
- Specifies which identity STS puts in the
sub(subject) claim of the JSON Web Token (JWT). Valid values areAWSIdentityandOriginIdentity. If you don't specify a value, Amazon Web Services STS usesAWSIdentity.-
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:SubjectModecondition key in a policy to control which subject modes a principal can request. -
- See Also:
-
-
subjectModeAsString
Specifies which identity STS puts in the
sub(subject) claim of the JSON Web Token (JWT). Valid values areAWSIdentityandOriginIdentity. If you don't specify a value, Amazon Web Services STS usesAWSIdentity.-
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:SubjectModecondition key in a policy to control which subject modes a principal can request.If the service returns an enum value that is not available in the current SDK version,
subjectModewill returnWebIdentityTokenSubjectModeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsubjectModeAsString().- Returns:
- Specifies which identity STS puts in the
sub(subject) claim of the JSON Web Token (JWT). Valid values areAWSIdentityandOriginIdentity. If you don't specify a value, Amazon Web Services STS usesAWSIdentity.-
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:SubjectModecondition key in a policy to control which subject modes a principal can request. -
- See Also:
-
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetWebIdentityTokenRequest.Builder,GetWebIdentityTokenRequest> - Specified by:
toBuilderin classStsRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-