Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Gets the user attributes and metadata for a user.
Synopsis
- data GetUser = GetUser' {}
- newGetUser :: Text -> GetUser
- getUser_accessToken :: Lens' GetUser Text
- data GetUserResponse = GetUserResponse' {}
- newGetUserResponse :: Int -> Text -> GetUserResponse
- getUserResponse_mfaOptions :: Lens' GetUserResponse (Maybe [MFAOptionType])
- getUserResponse_preferredMfaSetting :: Lens' GetUserResponse (Maybe Text)
- getUserResponse_userMFASettingList :: Lens' GetUserResponse (Maybe [Text])
- getUserResponse_httpStatus :: Lens' GetUserResponse Int
- getUserResponse_username :: Lens' GetUserResponse Text
- getUserResponse_userAttributes :: Lens' GetUserResponse [AttributeType]
Creating a Request
Represents the request to get information about the user.
See: newGetUser
smart constructor.
GetUser' | |
|
Instances
Create a value of GetUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetUser
, getUser_accessToken
- A non-expired access token for the user whose information you want to
query.
Request Lenses
getUser_accessToken :: Lens' GetUser Text Source #
A non-expired access token for the user whose information you want to query.
Destructuring the Response
data GetUserResponse Source #
Represents the response from the server from the request to get information about the user.
See: newGetUserResponse
smart constructor.
GetUserResponse' | |
|
Instances
Create a value of GetUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetUserResponse
, getUserResponse_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.
$sel:preferredMfaSetting:GetUserResponse'
, getUserResponse_preferredMfaSetting
- The user's preferred MFA setting.
$sel:userMFASettingList:GetUserResponse'
, getUserResponse_userMFASettingList
- The MFA options that are activated for the user. The possible values in
this list are SMS_MFA
and SOFTWARE_TOKEN_MFA
.
$sel:httpStatus:GetUserResponse'
, getUserResponse_httpStatus
- The response's http status code.
GetUserResponse
, getUserResponse_username
- The user name of the user you want to retrieve from the get user
request.
$sel:userAttributes:GetUserResponse'
, getUserResponse_userAttributes
- An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the
attribute name.
Response Lenses
getUserResponse_mfaOptions :: Lens' GetUserResponse (Maybe [MFAOptionType]) Source #
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.
getUserResponse_preferredMfaSetting :: Lens' GetUserResponse (Maybe Text) Source #
The user's preferred MFA setting.
getUserResponse_userMFASettingList :: Lens' GetUserResponse (Maybe [Text]) Source #
The MFA options that are activated for the user. The possible values in
this list are SMS_MFA
and SOFTWARE_TOKEN_MFA
.
getUserResponse_httpStatus :: Lens' GetUserResponse Int Source #
The response's http status code.
getUserResponse_username :: Lens' GetUserResponse Text Source #
The user name of the user you want to retrieve from the get user request.
getUserResponse_userAttributes :: Lens' GetUserResponse [AttributeType] Source #
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the
attribute name.