Skip to content

/AWS1/CL_CGP=>SETUSERSETTINGS()

About SetUserSettings

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. To configure either type of MFA, use SetUserMFAPreference instead.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Method Signature

IMPORTING

Required arguments:

IV_ACCESSTOKEN TYPE /AWS1/CGPTOKENMODELTYPE /AWS1/CGPTOKENMODELTYPE

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

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_CGPSETUSERSTGSRSP /AWS1/CL_CGPSETUSERSTGSRSP