Abstract class for AWS Cognito user management requests.
More...
#include <AWSCognitoUserManagementBus.h>
Abstract class for AWS Cognito user management requests.
◆ ConfirmForgotPasswordAsync()
virtual void AWSClientAuth::IAWSCognitoUserManagementRequests::ConfirmForgotPasswordAsync |
( |
const AZStd::string & |
userName, |
|
|
const AZStd::string & |
confirmationCode, |
|
|
const AZStd::string & |
newPassword |
|
) |
| |
|
pure virtual |
Cognito user pool confirm forgot password with confirmation code.
- Parameters
-
username | User name to use to confirm reset password for. |
confirmationCode | Code sent to email/phone for forgot password step. |
newPassword | New password to set the changed value to. |
◆ ConfirmSignUpAsync()
virtual void AWSClientAuth::IAWSCognitoUserManagementRequests::ConfirmSignUpAsync |
( |
const AZStd::string & |
userName, |
|
|
const AZStd::string & |
confirmationCode |
|
) |
| |
|
pure virtual |
Cognito user pool confirm sign up with confirmation code. Used to confirm email or phone sign up.
- Parameters
-
username | User name to use to confirm sign up. |
confirmationCode | Code sent to email/phone from sign up call. |
◆ EmailSignUpAsync()
virtual void AWSClientAuth::IAWSCognitoUserManagementRequests::EmailSignUpAsync |
( |
const AZStd::string & |
userName, |
|
|
const AZStd::string & |
password, |
|
|
const AZStd::string & |
email |
|
) |
| |
|
pure virtual |
Cognito user pool email sign up start.
- Parameters
-
username | User name to use for sign up. |
password | Password to use for sign up. |
email | Email used to send confirmation code. |
◆ EnableMFAAsync()
virtual void AWSClientAuth::IAWSCognitoUserManagementRequests::EnableMFAAsync |
( |
const AZStd::string & |
accessToken | ) |
|
|
pure virtual |
Cognito user pool enable multi factor authentication for signed in user.
- Parameters
-
accessToken | Access token from successful sign in. |
◆ ForgotPasswordAsync()
virtual void AWSClientAuth::IAWSCognitoUserManagementRequests::ForgotPasswordAsync |
( |
const AZStd::string & |
userName | ) |
|
|
pure virtual |
Cognito user forgot password start
- Parameters
-
username | User name to use to reset password for. |
◆ Initialize()
virtual bool AWSClientAuth::IAWSCognitoUserManagementRequests::Initialize |
( |
| ) |
|
|
pure virtual |
Initialize Cognito User pool using settings from resource mappings.
- Parameters
-
settingsRegistryPath | settingsRegistryPath Path for the settings registry file to use. |
◆ PhoneSignUpAsync()
virtual void AWSClientAuth::IAWSCognitoUserManagementRequests::PhoneSignUpAsync |
( |
const AZStd::string & |
userName, |
|
|
const AZStd::string & |
password, |
|
|
const AZStd::string & |
phoneNumber |
|
) |
| |
|
pure virtual |
Cognito user pool phone sign up start.
- Parameters
-
username | User name to use for sign up. |
password | Password to use for sign up. |
phoneNumber | Phone number used to send confirmation code. |
The documentation for this class was generated from the following file:
- Gems/AWSClientAuth/Code/Include/UserManagement/AWSCognitoUserManagementBus.h