STARTDEVICEAUTHORIZATION()`¶

About StartDeviceAuthorization¶

Initiates device authorization by requesting a pair of verification codes from the authorization service.

Method Signature¶

METHODS /AWS1/IF_SSI~STARTDEVICEAUTHORIZATION
  IMPORTING
    !IV_CLIENTID TYPE /AWS1/SSICLIENTID OPTIONAL
    !IV_CLIENTSECRET TYPE /AWS1/SSICLIENTSECRET OPTIONAL
    !IV_STARTURL TYPE /AWS1/SSIURI OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssistartdeviceauthrsp
  RAISING
    /AWS1/CX_SSIINTERNALSERVEREX
    /AWS1/CX_SSIINVALIDCLIENTEX
    /AWS1/CX_SSIINVALIDREQUESTEX
    /AWS1/CX_SSISLOWDOWNEXCEPTION
    /AWS1/CX_SSIUNAUTHDCLIENTEX
    /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 that is registered with IAM Identity Center. This value should come from the persisted result of the RegisterClient API operation.

`iv_clientsecret` `TYPE /AWS1/SSICLIENTSECRET` `/AWS1/SSICLIENTSECRET`¶

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

`iv_starturl` `TYPE /AWS1/SSIURI` `/AWS1/SSIURI`¶

The URL for the Amazon Web Services access portal. For more information, see Using the Amazon Web Services access portal in the IAM Identity Center User Guide.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssistartdeviceauthrsp` `/AWS1/CL_SSISTARTDEVICEAUTHRSP`¶

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->startdeviceauthorization(
  iv_clientid = |string|
  iv_clientsecret = |string|
  iv_starturl = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_devicecode = lo_result->get_devicecode( ).
  lv_usercode = lo_result->get_usercode( ).
  lv_uri = lo_result->get_verificationuri( ).
  lv_uri = lo_result->get_verificationuricomplete( ).
  lv_expirationinseconds = lo_result->get_expiresin( ).
  lv_intervalinseconds = lo_result->get_interval( ).
ENDIF.

Call OAuth/OIDC /start-device-authorization endpoint¶

DATA(lo_result) = lo_client->startdeviceauthorization(
  iv_clientid = |_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID|
  iv_clientsecret = |VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0|
  iv_starturl = |https://identitycenter.amazonaws.com/ssoins-111111111111|
).

/AWS1/IF_SSI=>STARTDEVICEAUTHORIZATION()¶