SETUICUSTOMIZATION()`¶

About SetUICustomization¶

Configures UI branding settings for domains with the hosted UI (classic) branding version. Your user pool must have a domain. Configure a domain with .

Set the default configuration for all clients with a ClientId of ALL. When the ClientId value is an app client ID, the settings you pass in this request apply to that app client and override the default ALL configuration.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Method Signature¶

METHODS /AWS1/IF_CGP~SETUICUSTOMIZATION
  IMPORTING
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_CLIENTID TYPE /AWS1/CGPCLIENTIDTYPE OPTIONAL
    !IV_CSS TYPE /AWS1/CGPCSSTYPE OPTIONAL
    !IV_IMAGEFILE TYPE /AWS1/CGPIMAGEFILETYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgpsetuicustization01
  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 where you want to apply branding to the classic hosted UI.

Optional arguments:¶

`iv_clientid` `TYPE /AWS1/CGPCLIENTIDTYPE` `/AWS1/CGPCLIENTIDTYPE`¶

The ID of the app client that you want to customize. To apply a default style to all app clients not configured with client-level branding, set this parameter value to ALL.

`iv_css` `TYPE /AWS1/CGPCSSTYPE` `/AWS1/CGPCSSTYPE`¶

A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool App clients tab, select Login pages, edit Hosted UI (classic) style, and select the link to CSS template.css.

`iv_imagefile` `TYPE /AWS1/CGPIMAGEFILETYPE` `/AWS1/CGPIMAGEFILETYPE`¶

The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cgpsetuicustization01` `/AWS1/CL_CGPSETUICUSTIZATION01`¶

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->setuicustomization(
  iv_clientid = |string|
  iv_css = |string|
  iv_imagefile = '5347567362473873563239796247513D'
  iv_userpoolid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_uicustomizationtype = lo_result->get_uicustomization( ).
  IF lo_uicustomizationtype IS NOT INITIAL.
    lv_userpoolidtype = lo_uicustomizationtype->get_userpoolid( ).
    lv_clientidtype = lo_uicustomizationtype->get_clientid( ).
    lv_imageurltype = lo_uicustomizationtype->get_imageurl( ).
    lv_csstype = lo_uicustomizationtype->get_css( ).
    lv_cssversiontype = lo_uicustomizationtype->get_cssversion( ).
    lv_datetype = lo_uicustomizationtype->get_lastmodifieddate( ).
    lv_datetype = lo_uicustomizationtype->get_creationdate( ).
  ENDIF.
ENDIF.

/AWS1/IF_CGP=>SETUICUSTOMIZATION()¶