INITIATEPROVIDERREGISTRATION()`¶

About InitiateProviderRegistration¶

Initiates the OAuth registration flow with a third-party provider. Returns a redirect URL and CSRF state token for completing the authorization.

Method Signature¶

METHODS /AWS1/IF_SAG~INITIATEPROVIDERREGISTRATION
  IMPORTING
    !IV_PROVIDER TYPE /AWS1/SAGPROVIDER OPTIONAL
    !IV_TARGETURL TYPE /AWS1/SAGTARGETURL OPTIONAL
    !IV_ORGANIZATIONNAME TYPE /AWS1/SAGSTRING OPTIONAL
    !IV_CLIENTID TYPE /AWS1/SAGCLIENTID OPTIONAL
    !IV_CLIENTSECRET TYPE /AWS1/SAGCLIENTSECRET OPTIONAL
  PREFERRED PARAMETER iv_provider
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_saginitpvdrregoutput
  RAISING
    /AWS1/CX_SAGACCESSDENIEDEX
    /AWS1/CX_SAGCONFLICTEXCEPTION
    /AWS1/CX_SAGINTERNALSERVEREX
    /AWS1/CX_SAGRESOURCENOTFOUNDEX
    /AWS1/CX_SAGTHROTTLINGEX
    /AWS1/CX_SAGVLDTNEXCEPTION
    /AWS1/CX_SAGCLIENTEXC
    /AWS1/CX_SAGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_provider` `TYPE /AWS1/SAGPROVIDER` `/AWS1/SAGPROVIDER`¶

The provider to initiate registration with.

Optional arguments:¶

`iv_targeturl` `TYPE /AWS1/SAGTARGETURL` `/AWS1/SAGTARGETURL`¶

The HTTPS URL of a self-managed provider instance. Omit for SaaS providers.

`iv_organizationname` `TYPE /AWS1/SAGSTRING` `/AWS1/SAGSTRING`¶

The name of the organization to connect.

`iv_clientid` `TYPE /AWS1/SAGCLIENTID` `/AWS1/SAGCLIENTID`¶

The client ID of the OAuth application registered on your self-managed provider instance.

`iv_clientsecret` `TYPE /AWS1/SAGCLIENTSECRET` `/AWS1/SAGCLIENTSECRET`¶

The client secret of the OAuth application registered on your self-managed provider instance.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_saginitpvdrregoutput` `/AWS1/CL_SAGINITPVDRREGOUTPUT`¶

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->initiateproviderregistration(
  iv_clientid = |string|
  iv_clientsecret = |string|
  iv_organizationname = |string|
  iv_provider = |string|
  iv_targeturl = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_location = lo_result->get_redirectto( ).
  lv_csrfstate = lo_result->get_csrfstate( ).
ENDIF.

/AWS1/IF_SAG=>INITIATEPROVIDERREGISTRATION()¶