Skip to content

CreateTokenRequest

Source code in docs_src/capo_sso_oidc/types/create_token_request.py
class CreateTokenRequest(TypedDict, closed=True):
    client_id: "capo_sso_oidc.types.client_id.ClientId"
    """<p>The unique identifier string for the client or application. This value comes from the result of the <a>RegisterClient</a> API.</p>"""
    client_secret: "capo_sso_oidc.types.client_secret.ClientSecret"
    """<p>A secret string generated for the client. This value should come from the persisted result of the <a>RegisterClient</a> API.</p>"""
    grant_type: "capo_sso_oidc.types.grant_type.GrantType"
    """<p>Supports the following OAuth grant types: Authorization Code, Device Code, and Refresh Token. Specify one of the following values, depending on the grant type that you want:</p> <p>* Authorization Code - <code>authorization_code</code> </p> <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code> </p> <p>* Refresh Token - <code>refresh_token</code> </p>"""
    device_code: NotRequired["capo_sso_oidc.types.device_code.DeviceCode"]
    """<p>Used only when calling this API for the Device Code grant type. This short-lived code is used to identify this authorization request. This comes from the result of the <a>StartDeviceAuthorization</a> API.</p>"""
    code: NotRequired["capo_sso_oidc.types.auth_code.AuthCode"]
    """<p>Used only when calling this API for the Authorization Code grant type. The short-lived code is used to identify this authorization request.</p>"""
    refresh_token: NotRequired["capo_sso_oidc.types.refresh_token.RefreshToken"]
    """<p>Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived tokens, such as the access token, that might expire.</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>"""
    scope: NotRequired["capo_sso_oidc.types.scopes.Scopes"]
    """<p>The list of scopes for which authorization is requested. This parameter has no effect; the access token will always include all scopes configured during client registration.</p>"""
    redirect_uri: NotRequired["capo_sso_oidc.types.uri.URI"]
    """<p>Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.</p>"""
    code_verifier: NotRequired["capo_sso_oidc.types.code_verifier.CodeVerifier"]
    """<p>Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.</p>"""

client_id instance-attribute

client_id: ClientId

The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

client_secret instance-attribute

client_secret: ClientSecret

A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

code instance-attribute

code: NotRequired[AuthCode]

Used only when calling this API for the Authorization Code grant type. The short-lived code is used to identify this authorization request.

code_verifier instance-attribute

code_verifier: NotRequired[CodeVerifier]

Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.

device_code instance-attribute

device_code: NotRequired[DeviceCode]

Used only when calling this API for the Device Code grant type. This short-lived code is used to identify this authorization request. This comes from the result of the StartDeviceAuthorization API.

grant_type instance-attribute

grant_type: GrantType

Supports the following OAuth grant types: Authorization Code, Device Code, and Refresh Token. Specify one of the following values, depending on the grant type that you want:

* Authorization Code - authorization_code

* Device Code - urn:ietf:params:oauth:grant-type:device_code

* Refresh Token - refresh_token

redirect_uri instance-attribute

redirect_uri: NotRequired[URI]

Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.

refresh_token instance-attribute

refresh_token: NotRequired[RefreshToken]

Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived tokens, such as the access token, that might expire.

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 requested. This parameter has no effect; the access token will always include all scopes configured during client registration.