DESCRIBEMANAGEDLOGINBRANDING()`¶

About DescribeManagedLoginBranding¶

Given the ID of a managed login branding style, returns detailed information about the style.

Method Signature¶

METHODS /AWS1/IF_CGP~DESCRIBEMANAGEDLOGINBRANDING
  IMPORTING
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_MANAGEDLOGINBRANDINGID TYPE /AWS1/CGPMANAGEDLOGINBRANDIN00 OPTIONAL
    !IV_RETURNMERGEDRESOURCES TYPE /AWS1/CGPBOOLEANTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgpdscmanagedloginb01
  RAISING
    /AWS1/CX_CGPINTERNALERROREX
    /AWS1/CX_CGPINVALIDPARAMETEREX
    /AWS1/CX_CGPNOTAUTHORIZEDEX
    /AWS1/CX_CGPRESOURCENOTFOUNDEX
    /AWS1/CX_CGPTOOMANYREQUESTSEX
    /AWS1/CX_CGPCLIENTEXC
    /AWS1/CX_CGPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_userpoolid` `TYPE /AWS1/CGPUSERPOOLIDTYPE` `/AWS1/CGPUSERPOOLIDTYPE`¶

The ID of the user pool that contains the managed login branding style that you want to get information about.

`iv_managedloginbrandingid` `TYPE /AWS1/CGPMANAGEDLOGINBRANDIN00` `/AWS1/CGPMANAGEDLOGINBRANDIN00`¶

The ID of the managed login branding style that you want to get more information about.

Optional arguments:¶

`iv_returnmergedresources` `TYPE /AWS1/CGPBOOLEANTYPE` `/AWS1/CGPBOOLEANTYPE`¶

When true, returns values for branding options that are unchanged from Amazon Cognito defaults. When false or when you omit this parameter, returns only values that you customized in your branding style.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cgpdscmanagedloginb01` `/AWS1/CL_CGPDSCMANAGEDLOGINB01`¶

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->describemanagedloginbranding(
  iv_managedloginbrandingid = |string|
  iv_returnmergedresources = ABAP_TRUE
  iv_userpoolid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_managedloginbrandingtyp = lo_result->get_managedloginbranding( ).
  IF lo_managedloginbrandingtyp IS NOT INITIAL.
    lv_managedloginbrandingidt = lo_managedloginbrandingtyp->get_managedloginbrandingid( ).
    lv_userpoolidtype = lo_managedloginbrandingtyp->get_userpoolid( ).
    lv_booleantype = lo_managedloginbrandingtyp->get_usecognitoprovidedvalues( ).
    lo_value = lo_managedloginbrandingtyp->get_settings( ).
    IF lo_value IS NOT INITIAL.
    ENDIF.
    LOOP AT lo_managedloginbrandingtyp->get_assets( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_assetcategorytype = lo_row_1->get_category( ).
        lv_colorschememodetype = lo_row_1->get_colormode( ).
        lv_assetextensiontype = lo_row_1->get_extension( ).
        lv_assetbytestype = lo_row_1->get_bytes( ).
        lv_resourceidtype = lo_row_1->get_resourceid( ).
      ENDIF.
    ENDLOOP.
    lv_datetype = lo_managedloginbrandingtyp->get_creationdate( ).
    lv_datetype = lo_managedloginbrandingtyp->get_lastmodifieddate( ).
  ENDIF.
ENDIF.

/AWS1/IF_CGP=>DESCRIBEMANAGEDLOGINBRANDING()¶