SSOOIDC / Client / create_token_with_iam

create_token_with_iam#

SSOOIDC.Client.create_token_with_iam(**kwargs)#

Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM entities. The access token can be used to fetch short-term credentials for the assigned Amazon Web Services accounts or to access application APIs using bearer authentication.

See also: AWS API Documentation

Request Syntax

response = client.create_token_with_iam(
    clientId='string',
    grantType='string',
    code='string',
    refreshToken='string',
    assertion='string',
    scope=[
        'string',
    ],
    redirectUri='string',
    subjectToken='string',
    subjectTokenType='string',
    requestedTokenType='string',
    codeVerifier='string'
)
Parameters:

  • clientId (string) –

    [REQUIRED]

    The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

  • grantType (string) –

    [REQUIRED]

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

    • Authorization Code - authorization_code

    • Refresh Token - refresh_token

    • JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer

    • Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange

  • code (string) – Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.

  • refreshToken (string) –

    Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term 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.

  • assertion (string) – Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.

  • scope (list) –

    The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

    • (string) –

  • redirectUri (string) – 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.

  • subjectToken (string) – Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.

  • subjectTokenType (string) –

    Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:

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

  • requestedTokenType (string) –

    Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. 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

  • codeVerifier (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'accessToken': 'string',
    'tokenType': 'string',
    'expiresIn': 123,
    'refreshToken': 'string',
    'idToken': 'string',
    'issuedTokenType': 'string',
    'scope': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • accessToken (string) –

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

    • tokenType (string) –

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

    • expiresIn (integer) –

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

    • refreshToken (string) –

      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.

    • idToken (string) –

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

    • issuedTokenType (string) –

      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

    • scope (list) –

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

      • (string) –

Exceptions

  • SSOOIDC.Client.exceptions.InvalidRequestException

  • SSOOIDC.Client.exceptions.InvalidClientException

  • SSOOIDC.Client.exceptions.InvalidGrantException

  • SSOOIDC.Client.exceptions.UnauthorizedClientException

  • SSOOIDC.Client.exceptions.UnsupportedGrantTypeException

  • SSOOIDC.Client.exceptions.InvalidScopeException

  • SSOOIDC.Client.exceptions.AuthorizationPendingException

  • SSOOIDC.Client.exceptions.SlowDownException

  • SSOOIDC.Client.exceptions.AccessDeniedException

  • SSOOIDC.Client.exceptions.ExpiredTokenException

  • SSOOIDC.Client.exceptions.InternalServerException

  • SSOOIDC.Client.exceptions.InvalidRequestRegionException