AWSClientAuth::GoogleAuthenticationProvider Class Reference

Implements OAuth2.0 device flow for Google authentication service. More...

#include <GoogleAuthenticationProvider.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 bool	Initialize ()=0
virtual void	PasswordGrantSingleFactorSignInAsync (const AZStd::string &username, const AZStd::string &password)=0
virtual void	PasswordGrantMultiFactorSignInAsync (const AZStd::string &username, const AZStd::string &password)=0
virtual void	PasswordGrantMultiFactorConfirmSignInAsync (const AZStd::string &username, const AZStd::string &confirmationCode)=0
virtual void	DeviceCodeGrantSignInAsync ()=0
	Call code-pair endpoint for provider device grant flow.
virtual void	DeviceCodeGrantConfirmSignInAsync ()=0
	Call tokens endpoint for provider device grant flow.
virtual void	RefreshTokensAsync ()=0
	Call refresh endpoint for provider refresh grant flow.
virtual AuthenticationTokens	GetAuthenticationTokens ()
virtual void	SignOut ()
	Clears all cached tokens and expiry.

Protected Attributes
AZStd::unique_ptr< GoogleProviderSetting >	m_settings
Protected Attributes inherited from AWSClientAuth::AuthenticationProviderInterface
AuthenticationTokens	m_authenticationTokens

Detailed Description

Implements OAuth2.0 device flow for Google authentication service.

Member Function Documentation

DeviceCodeGrantConfirmSignInAsync()

void AWSClientAuth::GoogleAuthenticationProvider::DeviceCodeGrantConfirmSignInAsync ( )

overridevirtual

Call tokens endpoint for provider device grant flow.

Implements AWSClientAuth::AuthenticationProviderInterface.

DeviceCodeGrantSignInAsync()

void AWSClientAuth::GoogleAuthenticationProvider::DeviceCodeGrantSignInAsync ( )

overridevirtual

Call code-pair endpoint for provider device grant flow.

Implements AWSClientAuth::AuthenticationProviderInterface.

Initialize()

bool AWSClientAuth::GoogleAuthenticationProvider::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::GoogleAuthenticationProvider::PasswordGrantMultiFactorConfirmSignInAsync ( const AZStd::string &  username, const AZStd::string &  confirmationCode  )

overridevirtual

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

Parameters

username	Username to use for MFA confirm.
confirmationCode	Confirmation code (sent to email/text) to use for MFA confirm.

Implements AWSClientAuth::AuthenticationProviderInterface.

PasswordGrantMultiFactorSignInAsync()

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

overridevirtual

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

Parameters

username	Username to use for MFA sign in.
password	Password to use for MFA sign in.

Implements AWSClientAuth::AuthenticationProviderInterface.

PasswordGrantSingleFactorSignInAsync()

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

overridevirtual

Call sign in endpoint for provider password grant flow.

Parameters

username	Username to use to for sign in.
password	Password to use to for sign in.

Implements AWSClientAuth::AuthenticationProviderInterface.

RefreshTokensAsync()

void AWSClientAuth::GoogleAuthenticationProvider::RefreshTokensAsync ( )

overridevirtual

Call refresh endpoint for provider refresh grant flow.

Implements AWSClientAuth::AuthenticationProviderInterface.

---

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

• Gems/AWSClientAuth/Code/Source/Authentication/GoogleAuthenticationProvider.h