Skip to content

/AWS1/IF_SSI=>CREATETOKEN()

About CreateToken

Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-lived credentials for the assigned AWS accounts or to access application APIs using bearer authentication.

Method Signature

METHODS /AWS1/IF_SSI~CREATETOKEN
  IMPORTING
    !IV_CLIENTID TYPE /AWS1/SSICLIENTID OPTIONAL
    !IV_CLIENTSECRET TYPE /AWS1/SSICLIENTSECRET OPTIONAL
    !IV_GRANTTYPE TYPE /AWS1/SSIGRANTTYPE OPTIONAL
    !IV_DEVICECODE TYPE /AWS1/SSIDEVICECODE OPTIONAL
    !IV_CODE TYPE /AWS1/SSIAUTHCODE OPTIONAL
    !IV_REFRESHTOKEN TYPE /AWS1/SSIREFRESHTOKEN OPTIONAL
    !IT_SCOPE TYPE /AWS1/CL_SSISCOPES_W=>TT_SCOPES OPTIONAL
    !IV_REDIRECTURI TYPE /AWS1/SSIURI OPTIONAL
    !IV_CODEVERIFIER TYPE /AWS1/SSICODEVERIFIER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssicreatetokenrsp
  RAISING
    /AWS1/CX_SSIACCESSDENIEDEX
    /AWS1/CX_SSIAUTHPENDINGEX
    /AWS1/CX_SSIEXPIREDTOKENEX
    /AWS1/CX_SSIINTERNALSERVEREX
    /AWS1/CX_SSIINVALIDCLIENTEX
    /AWS1/CX_SSIINVALIDGRANTEX
    /AWS1/CX_SSIINVALIDREQUESTEX
    /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 comes from the result of the RegisterClient API.

iv_clientsecret TYPE /AWS1/SSICLIENTSECRET /AWS1/SSICLIENTSECRET

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

iv_granttype TYPE /AWS1/SSIGRANTTYPE /AWS1/SSIGRANTTYPE

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

Optional arguments:

iv_devicecode TYPE /AWS1/SSIDEVICECODE /AWS1/SSIDEVICECODE

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.

iv_code TYPE /AWS1/SSIAUTHCODE /AWS1/SSIAUTHCODE

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

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.

it_scope TYPE /AWS1/CL_SSISCOPES_W=>TT_SCOPES TT_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.

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_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_ssicreatetokenrsp /AWS1/CL_SSICREATETOKENRSP

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->createtoken(
  it_scope = VALUE /aws1/cl_ssiscopes_w=>tt_scopes(
    ( new /aws1/cl_ssiscopes_w( |string| ) )
  )
  iv_clientid = |string|
  iv_clientsecret = |string|
  iv_code = |string|
  iv_codeverifier = |string|
  iv_devicecode = |string|
  iv_granttype = |string|
  iv_redirecturi = |string|
  iv_refreshtoken = |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( ).
ENDIF.

Call OAuth/OIDC /token endpoint for Device Code grant with Secret authentication

DATA(lo_result) = lo_client->createtoken(
  iv_clientid = |_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID|
  iv_clientsecret = |VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0|
  iv_devicecode = |yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzIn0EXAMPLEDEVICECODE|
  iv_granttype = |urn:ietf:params:oauth:grant-type:device-code|
).

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

DATA(lo_result) = lo_client->createtoken(
  it_scope = VALUE /aws1/cl_ssiscopes_w=>tt_scopes(
    ( new /aws1/cl_ssiscopes_w( |codewhisperer:completions| ) )
  )
  iv_clientid = |_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID|
  iv_clientsecret = |VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0|
  iv_granttype = |refresh_token|
  iv_refreshtoken = |aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN|
).