Skip to content

/AWS1/IF_SSI=>CREATETOKENWITHIAM()

About CreateTokenWithIAM

Creates and returns access and refresh tokens for authorized client applications that are authenticated using any IAM entity, such as a service role or user. These tokens might contain defined scopes that specify permissions such as read:profile or write:data. Through downscoping, you can use the scopes parameter to request tokens with reduced permissions compared to the original client application's permissions or, if applicable, the refresh token's scopes. The access token can be used to fetch short-lived credentials for the assigned Amazon Web Services accounts or to access application APIs using bearer authentication.

This API is used with Signature Version 4. For more information, see Amazon Web Services Signature Version 4 for API Requests.

Method Signature

METHODS /AWS1/IF_SSI~CREATETOKENWITHIAM
  IMPORTING
    !IV_CLIENTID TYPE /AWS1/SSICLIENTID OPTIONAL
    !IV_GRANTTYPE TYPE /AWS1/SSIGRANTTYPE OPTIONAL
    !IV_CODE TYPE /AWS1/SSIAUTHCODE OPTIONAL
    !IV_REFRESHTOKEN TYPE /AWS1/SSIREFRESHTOKEN OPTIONAL
    !IV_ASSERTION TYPE /AWS1/SSIASSERTION OPTIONAL
    !IT_SCOPE TYPE /AWS1/CL_SSISCOPES_W=>TT_SCOPES OPTIONAL
    !IV_REDIRECTURI TYPE /AWS1/SSIURI OPTIONAL
    !IV_SUBJECTTOKEN TYPE /AWS1/SSISUBJECTTOKEN OPTIONAL
    !IV_SUBJECTTOKENTYPE TYPE /AWS1/SSITOKENTYPEURI OPTIONAL
    !IV_REQUESTEDTOKENTYPE TYPE /AWS1/SSITOKENTYPEURI OPTIONAL
    !IV_CODEVERIFIER TYPE /AWS1/SSICODEVERIFIER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssicretokenwithiamrsp
  RAISING
    /AWS1/CX_SSIACCESSDENIEDEX
    /AWS1/CX_SSIAUTHPENDINGEX
    /AWS1/CX_SSIEXPIREDTOKENEX
    /AWS1/CX_SSIINTERNALSERVEREX
    /AWS1/CX_SSIINVALIDCLIENTEX
    /AWS1/CX_SSIINVALIDGRANTEX
    /AWS1/CX_SSIINVALIDREQUESTEX
    /AWS1/CX_SSIINVREQUESTREGIONEX
    /AWS1/CX_SSIINVALIDSCOPEEX
    /AWS1/CX_SSISLOWDOWNEXCEPTION
    /AWS1/CX_SSIUNAUTHDCLIENTEX
    /AWS1/CX_SSIUNSUPPEDGRANTTYP00
    /AWS1/CX_SSICLIENTEXC
    /AWS1/CX_SSISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_clientid TYPE /AWS1/SSICLIENTID /AWS1/SSICLIENTID

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

iv_granttype TYPE /AWS1/SSIGRANTTYPE /AWS1/SSIGRANTTYPE

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

Optional arguments:

iv_code TYPE /AWS1/SSIAUTHCODE /AWS1/SSIAUTHCODE

Used only when calling this API for the Authorization Code grant type. This short-lived 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.

iv_refreshtoken TYPE /AWS1/SSIREFRESHTOKEN /AWS1/SSIREFRESHTOKEN

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.

iv_assertion TYPE /AWS1/SSIASSERTION /AWS1/SSIASSERTION

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.

it_scope TYPE /AWS1/CL_SSISCOPES_W=>TT_SCOPES TT_SCOPES

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.

iv_redirecturi TYPE /AWS1/SSIURI /AWS1/SSIURI

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.

iv_subjecttoken TYPE /AWS1/SSISUBJECTTOKEN /AWS1/SSISUBJECTTOKEN

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.

iv_subjecttokentype TYPE /AWS1/SSITOKENTYPEURI /AWS1/SSITOKENTYPEURI

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

iv_requestedtokentype TYPE /AWS1/SSITOKENTYPEURI /AWS1/SSITOKENTYPEURI

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

iv_codeverifier TYPE /AWS1/SSICODEVERIFIER /AWS1/SSICODEVERIFIER

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_ssicretokenwithiamrsp /AWS1/CL_SSICRETOKENWITHIAMRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createtokenwithiam(
  it_scope = VALUE /aws1/cl_ssiscopes_w=>tt_scopes(
    ( new /aws1/cl_ssiscopes_w( |string| ) )
  )
  iv_assertion = |string|
  iv_clientid = |string|
  iv_code = |string|
  iv_codeverifier = |string|
  iv_granttype = |string|
  iv_redirecturi = |string|
  iv_refreshtoken = |string|
  iv_requestedtokentype = |string|
  iv_subjecttoken = |string|
  iv_subjecttokentype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_accesstoken = lo_result->get_accesstoken( ).
  lv_tokentype = lo_result->get_tokentype( ).
  lv_expirationinseconds = lo_result->get_expiresin( ).
  lv_refreshtoken = lo_result->get_refreshtoken( ).
  lv_idtoken = lo_result->get_idtoken( ).
  lv_tokentypeuri = lo_result->get_issuedtokentype( ).
  LOOP AT lo_result->get_scope( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_scope = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lo_awsadditionaldetails = lo_result->get_awsadditionaldetails( ).
  IF lo_awsadditionaldetails IS NOT INITIAL.
    lv_identitycontext = lo_awsadditionaldetails->get_identitycontext( ).
  ENDIF.
ENDIF.

Call OAuth/OIDC /token endpoint for Authorization Code grant with IAM authentication

DATA(lo_result) = lo_client->createtokenwithiam(
  it_scope = VALUE /aws1/cl_ssiscopes_w=>tt_scopes(
    ( new /aws1/cl_ssiscopes_w( |openid| ) )
    ( new /aws1/cl_ssiscopes_w( |aws| ) )
    ( new /aws1/cl_ssiscopes_w( |sts:identity_context| ) )
  )
  iv_clientid = |arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222|
  iv_code = |yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzg0In0EXAMPLEAUTHCODE|
  iv_granttype = |authorization_code|
  iv_redirecturi = |https://mywebapp.example/redirect|
).

Call OAuth/OIDC /token endpoint for JWT Bearer grant with IAM authentication

DATA(lo_result) = lo_client->createtokenwithiam(
  iv_assertion = |eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IjFMVE16YWtpaGlSbGFfOHoyQkVKVlhlV01xbyJ9.eyJ2ZXIiOiIyLjAiLCJpc3MiOiJodHRwczovL2xvZ2luLm1pY3Jvc29mdG9ubGluZS5jb20vOTEyMjA0MGQtNmM2Ny00YzViLWIxMTItMzZhMzA0YjY2ZGFkL3YyLjAiLCJzdWIiOiJBQUFBQUFBQUFBQUFBQUFBQUFBQUFJa3pxRlZyU2FTYUZIeTc4MmJidGFRIiwiYXVkIjoiNmNiMDQwMTgtYTNmNS00NmE3LWI5OTUtOTQwYzc4ZjVhZWYzIiwiZXhwIjoxNTM2MzYxNDExLCJpYXQiOjE1MzYyNzQ3MTEsIm5iZiI6MTUzNjI3NDcxMSwibmFtZSI6IkFiZSBMaW5jb2xuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoiQWJlTGlAbWljcm9zb2Z0LmNvbSIsIm9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC02NmYzLTMzMzJlY2E3ZWE4MSIsInRpZCI6IjkxMjIwNDBkLTZjNjctNGM1Yi1iMTEyLTM2YTMwNGI2NmRhZCIsIm5vbmNlIjoiMTIzNTIzIiwiYWlvIjoiRGYyVVZYTDFpeCFsTUNXTVNPSkJjRmF0emNHZnZGR2hqS3Y4cTVnMHg3MzJkUjVNQjVCaXN2R1FPN1lXQnlqZDhpUURMcSFlR2JJRGFreXA1bW5PcmNkcUhlWVNubHRlcFFtUnA2QUlaOGpZIn0.1AFWW-Ck5nROwSlltm7GzZvDwUkqvhSQpm55TQsmVo9Y59cLhRXpvB8n-55HCr9Z6G_31_UbeUkoz612I2j_Sm9FFShSDDjoaLQr54CreGIJvjtmS3EkK9a7SJBbcpL1MpUtlfygow39tFjY7EVNW9plWUvRrTgVk7lYLprvfzw-CIqw3gHC-T7IK_m_xkr08INERBtaecwhTeN4chPC4W3jdmw_lIxzC48YoQ0dB1L9-ImX98Egypfrlbm0IBL5spFzL6JDZIRRJOu8vecJvj1mq-IUhGt0MacxX8jdxYLP-KUu2d9MbNKpCKJuZ7p8gwTL5B7NlUdh_dmSviPWrw|
  iv_clientid = |arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222|
  iv_granttype = |urn:ietf:params:oauth:grant-type:jwt-bearer|
).

Call OAuth/OIDC /token endpoint for Refresh Token grant with IAM authentication

DATA(lo_result) = lo_client->createtokenwithiam(
  iv_clientid = |arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222|
  iv_granttype = |refresh_token|
  iv_refreshtoken = |aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN|
).

Call OAuth/OIDC /token endpoint for Token Exchange grant with IAM authentication

DATA(lo_result) = lo_client->createtokenwithiam(
  iv_clientid = |arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222|
  iv_granttype = |urn:ietf:params:oauth:grant-type:token-exchange|
  iv_requestedtokentype = |urn:ietf:params:oauth:token-type:access_token|
  iv_subjecttoken = |aoak-Hig8TUDPNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZDIFFERENTACCESSTOKEN|
  iv_subjecttokentype = |urn:ietf:params:oauth:token-type:access_token|
).