/AWS1/CL_CGPGETUSERRESPONSE¶
Represents the response from the server from the request to get information about the user.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_username TYPE /AWS1/CGPUSERNAMETYPE /AWS1/CGPUSERNAMETYPE¶
The name of the user that you requested.
it_userattributes TYPE /AWS1/CL_CGPATTRIBUTETYPE=>TT_ATTRIBUTELISTTYPE TT_ATTRIBUTELISTTYPE¶
An array of name-value pairs representing user attributes.
Custom attributes are prepended with the
custom:prefix.
Optional arguments:¶
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, andSOFTWARE_TOKEN_MFA.
Queryable Attributes¶
Username¶
The name 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 representing user attributes.
Custom attributes are prepended with the
custom:prefix.
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 |
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, andSOFTWARE_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 |