ADMINGETUSERAUTHFACTORS()`¶

About AdminGetUserAuthFactors¶

Lists the authentication options for a user in a user pool. Returns the following:

The user's multi-factor authentication (MFA) preferences.
The user's options for choice-based authentication with the USER_AUTH flow.

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~ADMINGETUSERAUTHFACTORS
  IMPORTING
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_USERNAME TYPE /AWS1/CGPUSERNAMETYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgpadmingtusrauthfa01
  RAISING
    /AWS1/CX_CGPINTERNALERROREX
    /AWS1/CX_CGPINVALIDPARAMETEREX
    /AWS1/CX_CGPNOTAUTHORIZEDEX
    /AWS1/CX_CGPOPNOTENABLEDEX
    /AWS1/CX_CGPRESOURCENOTFOUNDEX
    /AWS1/CX_CGPTOOMANYREQUESTSEX
    /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 where you want to get information about the user's authentication factors.

`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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cgpadmingtusrauthfa01` `/AWS1/CL_CGPADMINGTUSRAUTHFA01`¶

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->admingetuserauthfactors(
  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.
  lv_usernametype = lo_result->get_username( ).
  lv_stringtype = lo_result->get_preferredmfasetting( ).
  LOOP AT lo_result->get_usermfasettinglist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_stringtype = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_cfgureduserauthfactors( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_authfactortype = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_CGP=>ADMINGETUSERAUTHFACTORS()¶