/AWS1/IF_CGP=>ADMINSETUSERSETTINGS()

About AdminSetUserSettings

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA.

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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Method Signature

METHODS /AWS1/IF_CGP~ADMINSETUSERSETTINGS
  IMPORTING
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_USERNAME TYPE /AWS1/CGPUSERNAMETYPE OPTIONAL
    !IT_MFAOPTIONS TYPE /AWS1/CL_CGPMFAOPTIONTYPE=>TT_MFAOPTIONLISTTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgpadminsetuserstgs01
  RAISING
    /AWS1/CX_CGPINTERNALERROREX
    /AWS1/CX_CGPINVALIDPARAMETEREX
    /AWS1/CX_CGPNOTAUTHORIZEDEX
    /AWS1/CX_CGPRESOURCENOTFOUNDEX
    /AWS1/CX_CGPUSERNOTFOUNDEX
    /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 user whose options you're setting.

iv_username TYPE /AWS1/CGPUSERNAMETYPE /AWS1/CGPUSERNAMETYPE

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

it_mfaoptions TYPE /AWS1/CL_CGPMFAOPTIONTYPE=>TT_MFAOPTIONLISTTYPE TT_MFAOPTIONLISTTYPE

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

RETURNING

oo_output TYPE REF TO /aws1/cl_cgpadminsetuserstgs01 /AWS1/CL_CGPADMINSETUSERSTGS01

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->adminsetusersettings(
  it_mfaoptions = VALUE /aws1/cl_cgpmfaoptiontype=>tt_mfaoptionlisttype(
    (
      new /aws1/cl_cgpmfaoptiontype(
        iv_attributename = |string|
        iv_deliverymedium = |string|
      )
    )
  )
  iv_username = |string|
  iv_userpoolid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.