Skip to content

/AWS1/CL_CGPADMINGETUSERRSP

Represents the response from the server from the request to get the specified user as an administrator.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_username TYPE /AWS1/CGPUSERNAMETYPE /AWS1/CGPUSERNAMETYPE

The username of the user that you requested.

Optional arguments:

it_userattributes TYPE /AWS1/CL_CGPATTRIBUTETYPE=>TT_ATTRIBUTELISTTYPE TT_ATTRIBUTELISTTYPE

An array of name-value pairs of user attributes and their values, for example "email": "testuser@example.com".

iv_usercreatedate TYPE /AWS1/CGPDATETYPE /AWS1/CGPDATETYPE

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

iv_userlastmodifieddate TYPE /AWS1/CGPDATETYPE /AWS1/CGPDATETYPE

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

iv_enabled TYPE /AWS1/CGPBOOLEANTYPE /AWS1/CGPBOOLEANTYPE

Indicates whether the user is activated for sign-in.

iv_userstatus TYPE /AWS1/CGPUSERSTATUSTYPE /AWS1/CGPUSERSTATUSTYPE

The user's status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • UNKNOWN - User status isn't known.

  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

  • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

  • EXTERNAL_PROVIDER - The user signed in with a third-party identity provider.

it_mfaoptions TYPE /AWS1/CL_CGPMFAOPTIONTYPE=>TT_MFAOPTIONLISTTYPE TT_MFAOPTIONLISTTYPE

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

iv_preferredmfasetting TYPE /AWS1/CGPSTRINGTYPE /AWS1/CGPSTRINGTYPE

The user's preferred MFA. 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.

Queryable Attributes

Username

The username of the user that you requested.

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

UserAttributes

An array of name-value pairs of user attributes and their values, for example "email": "testuser@example.com".

Accessible with the following methods

Method Description
GET_USERATTRIBUTES() Getter for USERATTRIBUTES, with configurable default
ASK_USERATTRIBUTES() Getter for USERATTRIBUTES w/ exceptions if field has no valu
HAS_USERATTRIBUTES() Determine if USERATTRIBUTES has a value

UserCreateDate

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Accessible with the following methods

Method Description
GET_USERCREATEDATE() Getter for USERCREATEDATE, with configurable default
ASK_USERCREATEDATE() Getter for USERCREATEDATE w/ exceptions if field has no valu
HAS_USERCREATEDATE() Determine if USERCREATEDATE has a value

UserLastModifiedDate

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Accessible with the following methods

Method Description
GET_USERLASTMODIFIEDDATE() Getter for USERLASTMODIFIEDDATE, with configurable default
ASK_USERLASTMODIFIEDDATE() Getter for USERLASTMODIFIEDDATE w/ exceptions if field has n
HAS_USERLASTMODIFIEDDATE() Determine if USERLASTMODIFIEDDATE has a value

Enabled

Indicates whether the user is activated for sign-in.

Accessible with the following methods

Method Description
GET_ENABLED() Getter for ENABLED

UserStatus

The user's status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • UNKNOWN - User status isn't known.

  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

  • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

  • EXTERNAL_PROVIDER - The user signed in with a third-party identity provider.

Accessible with the following methods

Method Description
GET_USERSTATUS() Getter for USERSTATUS, with configurable default
ASK_USERSTATUS() Getter for USERSTATUS w/ exceptions if field has no value
HAS_USERSTATUS() Determine if USERSTATUS has a value

MFAOptions

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

Accessible with the following methods

Method Description
GET_MFAOPTIONS() Getter for MFAOPTIONS, with configurable default
ASK_MFAOPTIONS() Getter for MFAOPTIONS w/ exceptions if field has no value
HAS_MFAOPTIONS() Determine if MFAOPTIONS has a value

PreferredMfaSetting

The user's preferred MFA. 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