web_identity_tokens

Creates, updates, deletes, gets or lists a web_identity_tokens resource.

Overview

Name	web_identity_tokens
Type	Resource
Id	aws.sts.web_identity_tokens

Fields

The following fields are returned by SELECT queries:

get_web_identity_token

Name	Datatype	Description
expiration	string	The date and time when the web identity token expires, in UTC. The expiration is determined by adding the DurationSeconds value to the time the token was issued. After this time, the token should no longer be considered valid.
web_identity_token	string	A signed JSON Web Token (JWT) that represents the caller's Amazon Web Services identity. The token contains standard JWT claims such as subject, audience, expiration time, and additional identity attributes added by STS as custom claims. You can also add your own custom claims to the token by passing tags as request parameters to the GetWebIdentityToken API. The token is signed using the specified signing algorithm and can be verified using the verification keys available at the issuer's JWKS endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_web_identity_token	select	SigningAlgorithm, region	Audience, DurationSeconds, Tags	Returns a signed JSON Web Token (JWT) that represents the calling Amazon Web Services identity. The returned JWT can be used to authenticate with external services that support OIDC discovery. The token is signed by Amazon Web Services STS and can be publicly verified using the verification keys published at the issuer's JWKS endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
SigningAlgorithm	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).
region	string	AWS region (default: us-east-1)
Audience	array	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.
DurationSeconds	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.
Tags	array	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.

SELECT examples

get_web_identity_token

Returns a signed JSON Web Token (JWT) that represents the calling Amazon Web Services identity. The returned JWT can be used to authenticate with external services that support OIDC discovery. The token is signed by Amazon Web Services STS and can be publicly verified using the verification keys published at the issuer's JWKS endpoint.

SELECT
expiration,
web_identity_token
FROM aws.sts.web_identity_tokens
WHERE SigningAlgorithm = '{{ SigningAlgorithm }}' -- required
AND region = '{{ region }}' -- required
AND Audience = '{{ Audience }}'
AND DurationSeconds = '{{ DurationSeconds }}'
AND Tags = '{{ Tags }}'
;