Open 3D Engine AWSClientAuth Gem API Reference  2205.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AWSClientAuth::IAWSCognitoUserManagementRequests Class Referenceabstract

Abstract class for AWS Cognito user management requests. More...

#include <AWSCognitoUserManagementBus.h>

Public Member Functions

 AZ_TYPE_INFO (IAWSCognitoUserManagementRequests, "{A4C90F21-7056-4827-8C6B-401E6945697D}")
 
virtual bool Initialize ()=0
 
virtual void EmailSignUpAsync (const AZStd::string &userName, const AZStd::string &password, const AZStd::string &email)=0
 
virtual void PhoneSignUpAsync (const AZStd::string &userName, const AZStd::string &password, const AZStd::string &phoneNumber)=0
 
virtual void ConfirmSignUpAsync (const AZStd::string &userName, const AZStd::string &confirmationCode)=0
 
virtual void ForgotPasswordAsync (const AZStd::string &userName)=0
 
virtual void ConfirmForgotPasswordAsync (const AZStd::string &userName, const AZStd::string &confirmationCode, const AZStd::string &newPassword)=0
 
virtual void EnableMFAAsync (const AZStd::string &accessToken)=0
 

Detailed Description

Abstract class for AWS Cognito user management requests.

Member Function Documentation

◆ 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
usernameUser name to use to confirm reset password for.
confirmationCodeCode sent to email/phone for forgot password step.
newPasswordNew 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
usernameUser name to use to confirm sign up.
confirmationCodeCode 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
usernameUser name to use for sign up.
passwordPassword to use for sign up.
emailEmail 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
accessTokenAccess token from successful sign in.

◆ ForgotPasswordAsync()

virtual void AWSClientAuth::IAWSCognitoUserManagementRequests::ForgotPasswordAsync ( const AZStd::string &  userName)
pure virtual

Cognito user forgot password start

Parameters
usernameUser 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
settingsRegistryPathsettingsRegistryPath 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
usernameUser name to use for sign up.
passwordPassword to use for sign up.
phoneNumberPhone number used to send confirmation code.

The documentation for this class was generated from the following file: