CREATEAUTHCODE()`¶

About CreateAuthCode¶

Creates an authorization code for the specified Connect Customer instance. The authorization code can be used to establish a session with scoped permissions defined by the specified scope parameters.

Method Signature¶

METHODS /AWS1/IF_CNT~CREATEAUTHCODE
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IO_SCOPE TYPE REF TO /AWS1/CL_CNTAUTHSCOPE OPTIONAL
    !IV_MAXSESSIONDURATIONMINUTES TYPE /AWS1/CNTMAXSESSIONDURMINUTES OPTIONAL
    !IV_SESSIONINACTVDURMINUTES TYPE /AWS1/CNTSESSIONINACTVDURMINS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntcreateauthcodersp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instanceid` `TYPE /AWS1/CNTINSTANCEID` `/AWS1/CNTINSTANCEID`¶

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

`io_scope` `TYPE REF TO /AWS1/CL_CNTAUTHSCOPE` `/AWS1/CL_CNTAUTHSCOPE`¶

The scope for the authorization code. Defines the permissions and access boundaries for the session.

`iv_sessioninactvdurminutes` `TYPE /AWS1/CNTSESSIONINACTVDURMINS` `/AWS1/CNTSESSIONINACTVDURMINS`¶

The duration of inactivity, in minutes, after which the session expires. Minimum value of 1440 (24 hours). Maximum value of 20160 (14 days).

Optional arguments:¶

`iv_maxsessiondurationminutes` `TYPE /AWS1/CNTMAXSESSIONDURMINUTES` `/AWS1/CNTMAXSESSIONDURMINUTES`¶

The maximum duration of the session, in minutes. Minimum value of 1440 (24 hours). Maximum value of 43200 (30 days). If no value is provided, the session will expire after 400 days.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntcreateauthcodersp` `/AWS1/CL_CNTCREATEAUTHCODERSP`¶

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->createauthcode(
  io_scope = new /aws1/cl_cntauthscope(
    it_securityprofileids = VALUE /aws1/cl_cntsecprofileids_w=>tt_securityprofileids(
      ( new /aws1/cl_cntsecprofileids_w( |string| ) )
    )
    iv_domainname = |string|
    iv_entityid = |string|
    iv_entitytype = |string|
  )
  iv_instanceid = |string|
  iv_maxsessiondurationminutes = 123
  iv_sessioninactvdurminutes = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_authcode = lo_result->get_authcode( ).
  lv_sessionid = lo_result->get_sessionid( ).
  lv_authcodeentitytype = lo_result->get_entitytype( ).
  lv_entityid = lo_result->get_entityid( ).
ENDIF.

/AWS1/IF_CNT=>CREATEAUTHCODE()¶