AWSClientAuth::AuthenticationProviderInterface Class Reference

#include <AuthenticationProviderInterface.h>

Inherited by AWSClientAuth::AWSCognitoAuthenticationProvider, AWSClientAuth::GoogleAuthenticationProvider, and AWSClientAuth::LWAAuthenticationProvider.

Public Member Functions
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
AuthenticationTokens	m_authenticationTokens

Detailed Description

Interface to be implemented by AuthenticationProviders to interact with AuthenticationManager. Follows grant types for password and device from following: https://oauth.net/2/grant-types/

Member Function Documentation

DeviceCodeGrantConfirmSignInAsync()

virtual void AWSClientAuth::AuthenticationProviderInterface::DeviceCodeGrantConfirmSignInAsync ( )

pure virtual

Call tokens endpoint for provider device grant flow.

Implemented in AWSClientAuth::AWSCognitoAuthenticationProvider, AWSClientAuth::GoogleAuthenticationProvider, and AWSClientAuth::LWAAuthenticationProvider.

DeviceCodeGrantSignInAsync()

virtual void AWSClientAuth::AuthenticationProviderInterface::DeviceCodeGrantSignInAsync ( )

pure virtual

Call code-pair endpoint for provider device grant flow.

Implemented in AWSClientAuth::AWSCognitoAuthenticationProvider, AWSClientAuth::GoogleAuthenticationProvider, and AWSClientAuth::LWAAuthenticationProvider.

GetAuthenticationTokens()

virtual AuthenticationTokens AWSClientAuth::AuthenticationProviderInterface::GetAuthenticationTokens ( )

virtual

Returns

Authentication tokens from last successful sign in.

Initialize()

virtual bool AWSClientAuth::AuthenticationProviderInterface::Initialize ( )

pure virtual

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.

Implemented in AWSClientAuth::AWSCognitoAuthenticationProvider, AWSClientAuth::GoogleAuthenticationProvider, and AWSClientAuth::LWAAuthenticationProvider.

PasswordGrantMultiFactorConfirmSignInAsync()

virtual void AWSClientAuth::AuthenticationProviderInterface::PasswordGrantMultiFactorConfirmSignInAsync ( const AZStd::string &  username, const AZStd::string &  confirmationCode  )

pure virtual

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.

Implemented in AWSClientAuth::AWSCognitoAuthenticationProvider, AWSClientAuth::GoogleAuthenticationProvider, and AWSClientAuth::LWAAuthenticationProvider.

PasswordGrantMultiFactorSignInAsync()

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

pure virtual

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.

Implemented in AWSClientAuth::AWSCognitoAuthenticationProvider, AWSClientAuth::GoogleAuthenticationProvider, and AWSClientAuth::LWAAuthenticationProvider.

PasswordGrantSingleFactorSignInAsync()

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

pure virtual

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.

Implemented in AWSClientAuth::AWSCognitoAuthenticationProvider, AWSClientAuth::GoogleAuthenticationProvider, and AWSClientAuth::LWAAuthenticationProvider.

RefreshTokensAsync()

virtual void AWSClientAuth::AuthenticationProviderInterface::RefreshTokensAsync ( )

pure virtual

Call refresh endpoint for provider refresh grant flow.

Implemented in AWSClientAuth::AWSCognitoAuthenticationProvider, AWSClientAuth::GoogleAuthenticationProvider, and AWSClientAuth::LWAAuthenticationProvider.

---

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

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