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

Implements AWS Cognito User pool authentication. More...

#include <AWSCognitoAuthenticationProvider.h>

Inherits AWSClientAuth::AuthenticationProviderInterface.

Public Member Functions

bool Initialize () override
 
void PasswordGrantSingleFactorSignInAsync (const AZStd::string &username, const AZStd::string &password) override
 
void PasswordGrantMultiFactorSignInAsync (const AZStd::string &username, const AZStd::string &password) override
 
void PasswordGrantMultiFactorConfirmSignInAsync (const AZStd::string &username, const AZStd::string &confirmationCode) override
 
void DeviceCodeGrantSignInAsync () override
 Call code-pair endpoint for provider device grant flow.
 
void DeviceCodeGrantConfirmSignInAsync () override
 Call tokens endpoint for provider device grant flow.
 
void RefreshTokensAsync () override
 Call refresh endpoint for provider refresh grant flow.
 
- Public Member Functions inherited from AWSClientAuth::AuthenticationProviderInterface
virtual AuthenticationTokens GetAuthenticationTokens ()
 
virtual void SignOut ()
 Clears all cached tokens and expiry.
 

Protected Attributes

AZStd::string m_session
 
AZStd::string m_cognitoAppClientId
 
- Protected Attributes inherited from AWSClientAuth::AuthenticationProviderInterface
AuthenticationTokens m_authenticationTokens
 

Detailed Description

Implements AWS Cognito User pool authentication.

Member Function Documentation

◆ Initialize()

bool AWSClientAuth::AWSCognitoAuthenticationProvider::Initialize ( )
overridevirtual

Extract required settings for the provider from setting registry.

Returns
bool True: if provider can parse required settings and validate. False: fails to parse required settings.

Implements AWSClientAuth::AuthenticationProviderInterface.

◆ PasswordGrantMultiFactorConfirmSignInAsync()

void AWSClientAuth::AWSCognitoAuthenticationProvider::PasswordGrantMultiFactorConfirmSignInAsync ( const AZStd::string &  username,
const AZStd::string &  confirmationCode 
)
overridevirtual

Call confirm endpoint for provider password grant multi factor authentication flow .

Parameters
usernameUsername to use for MFA confirm.
confirmationCodeConfirmation code (sent to email/text) to use for MFA confirm.

Implements AWSClientAuth::AuthenticationProviderInterface.

◆ PasswordGrantMultiFactorSignInAsync()

void AWSClientAuth::AWSCognitoAuthenticationProvider::PasswordGrantMultiFactorSignInAsync ( const AZStd::string &  username,
const AZStd::string &  password 
)
overridevirtual

Call sign in endpoint for provider password grant multi factor authentication flow.

Parameters
usernameUsername to use for MFA sign in.
passwordPassword to use for MFA sign in.

Implements AWSClientAuth::AuthenticationProviderInterface.

◆ PasswordGrantSingleFactorSignInAsync()

void AWSClientAuth::AWSCognitoAuthenticationProvider::PasswordGrantSingleFactorSignInAsync ( const AZStd::string &  username,
const AZStd::string &  password 
)
overridevirtual

Call sign in endpoint for provider password grant flow.

Parameters
usernameUsername to use to for sign in.
passwordPassword to use to for sign in.

Implements AWSClientAuth::AuthenticationProviderInterface.


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