Skip to content

CreateTokenWithIAMResponse

Source code in docs_src/capo_sso_oidc/types/create_token_with_iam_response.py
class CreateTokenWithIAMResponse(TypedDict, closed=True):
    access_token: NotRequired["capo_sso_oidc.types.access_token.AccessToken"]
    """<p>A bearer token to access Amazon Web Services accounts and applications assigned to a user.</p>"""
    token_type: NotRequired["capo_sso_oidc.types.token_type.TokenType"]
    """<p>Used to notify the requester that the returned token is an access token. The supported token type is <code>Bearer</code>.</p>"""
    expires_in: "capo_sso_oidc.types.expiration_in_seconds.ExpirationInSeconds"
    """<p>Indicates the time in seconds when an access token will expire.</p>"""
    refresh_token: NotRequired["capo_sso_oidc.types.refresh_token.RefreshToken"]
    """<p>A token that, if present, can be used to refresh a previously issued access token that might have expired.</p> <p>For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center OIDC API Reference</a>.</p>"""
    id_token: NotRequired["capo_sso_oidc.types.id_token.IdToken"]
    """<p>A JSON Web Token (JWT) that identifies the user associated with the issued access token. </p>"""
    issued_token_type: NotRequired["capo_sso_oidc.types.token_type_uri.TokenTypeURI"]
    """<p>Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported: </p> <p>* Access Token - <code>urn:ietf:params:oauth:token-type:access_token</code> </p> <p>* Refresh Token - <code>urn:ietf:params:oauth:token-type:refresh_token</code> </p>"""
    scope: NotRequired["capo_sso_oidc.types.scopes.Scopes"]
    """<p>The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.</p>"""
    aws_additional_details: NotRequired[
        "capo_sso_oidc.types.aws_additional_details.AwsAdditionalDetails"
    ]
    """<p>A structure containing information from IAM Identity Center managed user and group information.</p>"""

access_token instance-attribute

access_token: NotRequired[AccessToken]

A bearer token to access Amazon Web Services accounts and applications assigned to a user.

aws_additional_details instance-attribute

aws_additional_details: NotRequired[AwsAdditionalDetails]

A structure containing information from IAM Identity Center managed user and group information.

expires_in instance-attribute

expires_in: ExpirationInSeconds

Indicates the time in seconds when an access token will expire.

id_token instance-attribute

id_token: NotRequired[IdToken]

A JSON Web Token (JWT) that identifies the user associated with the issued access token.

issued_token_type instance-attribute

issued_token_type: NotRequired[TokenTypeURI]

Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:

* Access Token - urn:ietf:params:oauth:token-type:access_token

* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token

refresh_token instance-attribute

refresh_token: NotRequired[RefreshToken]

A token that, if present, can be used to refresh a previously issued access token that might have expired.

For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.

scope instance-attribute

scope: NotRequired[Scopes]

The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

token_type instance-attribute

token_type: NotRequired[TokenType]

Used to notify the requester that the returned token is an access token. The supported token type is Bearer.