Skip to content

/AWS1/CL_CGPADMINGTUSRAUTHFA01

AdminGetUserAuthFactorsResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_username TYPE /AWS1/CGPUSERNAMETYPE /AWS1/CGPUSERNAMETYPE

The name of the user who is eligible for the authentication factors in the response.

Optional arguments:

iv_preferredmfasetting TYPE /AWS1/CGPSTRINGTYPE /AWS1/CGPSTRINGTYPE

The challenge method that Amazon Cognito returns to the user in response to sign-in requests. Users can prefer SMS message, email message, or TOTP MFA.

it_usermfasettinglist TYPE /AWS1/CL_CGPUSERMFASETTINGLS00=>TT_USERMFASETTINGLISTTYPE TT_USERMFASETTINGLISTTYPE

The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

it_configureduserauthfactors TYPE /AWS1/CL_CGPCFGUREDUSERAUTHF00=>TT_CFGUREDUSERAUTHFACTORSLST00 TT_CFGUREDUSERAUTHFACTORSLST00

The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level.

Queryable Attributes

Username

The name of the user who is eligible for the authentication factors in the response.

Accessible with the following methods

Method Description
GET_USERNAME() Getter for USERNAME, with configurable default
ASK_USERNAME() Getter for USERNAME w/ exceptions if field has no value
HAS_USERNAME() Determine if USERNAME has a value

PreferredMfaSetting

The challenge method that Amazon Cognito returns to the user in response to sign-in requests. Users can prefer SMS message, email message, or TOTP MFA.

Accessible with the following methods

Method Description
GET_PREFERREDMFASETTING() Getter for PREFERREDMFASETTING, with configurable default
ASK_PREFERREDMFASETTING() Getter for PREFERREDMFASETTING w/ exceptions if field has no
HAS_PREFERREDMFASETTING() Determine if PREFERREDMFASETTING has a value

UserMFASettingList

The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

Accessible with the following methods

Method Description
GET_USERMFASETTINGLIST() Getter for USERMFASETTINGLIST, with configurable default
ASK_USERMFASETTINGLIST() Getter for USERMFASETTINGLIST w/ exceptions if field has no
HAS_USERMFASETTINGLIST() Determine if USERMFASETTINGLIST has a value

ConfiguredUserAuthFactors

The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

PASSWORD can only be used as a first authentication factor. SOFTWARE_TOKEN can only be used as an MFA factor. EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be used as either a first authentication factor or an MFA factor. WEB_AUTHN is available as an MFA factor only when passkey MFA is enabled at the user pool level.

Accessible with the following methods

Method Description
GET_CFGUREDUSERAUTHFACTORS() Getter for CONFIGUREDUSERAUTHFACTORS, with configurable defa
ASK_CFGUREDUSERAUTHFACTORS() Getter for CONFIGUREDUSERAUTHFACTORS w/ exceptions if field
HAS_CFGUREDUSERAUTHFACTORS() Determine if CONFIGUREDUSERAUTHFACTORS has a value