Skip to content

GetWebIdentityTokenRequest

Source code in docs_src/capo_sts/types/get_web_identity_token_request.py
class GetWebIdentityTokenRequest(TypedDict, closed=True):
    audience: "capo_sts.types.web_identity_token_audience_list_type.webIdentityTokenAudienceListType"
    """<p>The intended recipient of the web identity token. This value populates the <code>aud</code> 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.</p>"""
    duration_seconds: NotRequired[
        "capo_sts.types.web_identity_token_duration_seconds_type.webIdentityTokenDurationSecondsType"
    ]
    """<p>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.</p>"""
    signing_algorithm: "capo_sts.types.jwt_algorithm_type.jwtAlgorithmType"
    """<p>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). </p>"""
    tags: NotRequired["capo_sts.types.tag_list_type.tagListType"]
    """<p>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. </p>"""

audience instance-attribute

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.

duration_seconds instance-attribute

duration_seconds: NotRequired[webIdentityTokenDurationSecondsType]

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.

signing_algorithm instance-attribute

signing_algorithm: jwtAlgorithmType

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).

tags instance-attribute

tags: NotRequired[tagListType]

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.