AWSClientAuth::AuthenticationProviderNotifications Class Reference

Notification bus for Authentication Request bus. More...

#include <AuthenticationProviderBus.h>

Inherits AZ::EBusTraits.

Public Member Functions
virtual void	OnPasswordGrantSingleFactorSignInSuccess (const AuthenticationTokens &authenticationToken)
virtual void	OnPasswordGrantSingleFactorSignInFail (const AZStd::string &error)
virtual void	OnPasswordGrantMultiFactorSignInSuccess ()
virtual void	OnPasswordGrantMultiFactorSignInFail (const AZStd::string &error)
virtual void	OnPasswordGrantMultiFactorConfirmSignInSuccess (const AuthenticationTokens &authenticationToken)
virtual void	OnPasswordGrantMultiFactorConfirmSignInFail (const AZStd::string &error)
virtual void	OnDeviceCodeGrantSignInSuccess (const AZStd::string &userCode, const AZStd::string &verificationUrl, int codeExpiresInSeconds)
virtual void	OnDeviceCodeGrantSignInFail (const AZStd::string &error)
virtual void	OnDeviceCodeGrantConfirmSignInSuccess (const AuthenticationTokens &authenticationToken)
virtual void	OnDeviceCodeGrantConfirmSignInFail (const AZStd::string &error)
virtual void	OnRefreshTokensSuccess (const AuthenticationTokens &authenticationToken)
virtual void	OnRefreshTokensFail (const AZStd::string &error)
virtual void	OnSignOut (const ProviderNameEnum &provideName)

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::Single

Detailed Description

Notification bus for Authentication Request bus.

Member Function Documentation

OnDeviceCodeGrantConfirmSignInFail()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnDeviceCodeGrantConfirmSignInFail ( const AZStd::string &  error )

inlinevirtual

Event for DeviceCodeGrantConfirmSignIn fail.

Parameters

error

Error message

OnDeviceCodeGrantConfirmSignInSuccess()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnDeviceCodeGrantConfirmSignInSuccess ( const AuthenticationTokens &  authenticationToken )

inlinevirtual

Event for DeviceCodeGrantConfirmSignIn success.

Parameters

authenticationToken

Tokens on successful sign in..

OnDeviceCodeGrantSignInFail()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnDeviceCodeGrantSignInFail ( const AZStd::string &  error )

inlinevirtual

Event for DeviceCodeGrantSignIn fail.

Parameters

error

Error message

OnDeviceCodeGrantSignInSuccess()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnDeviceCodeGrantSignInSuccess ( const AZStd::string &  userCode, const AZStd::string &  verificationUrl, int  codeExpiresInSeconds  )

inlinevirtual

Event for DeviceCodeGrantSignIn success. Event use to notify user to take open verification url and enter displayed code.

Parameters

userCode	Unique code generated for user for the session.
verificationUrl	Verification URL to enter user code in after signing in for the provider.
codeExpiresInSeconds	Code expiry in seconds.

OnPasswordGrantMultiFactorConfirmSignInFail()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnPasswordGrantMultiFactorConfirmSignInFail ( const AZStd::string &  error )

inlinevirtual

Event for PasswordGrantMultiFactorConfirm fail.

Parameters

error

Error message

OnPasswordGrantMultiFactorConfirmSignInSuccess()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnPasswordGrantMultiFactorConfirmSignInSuccess ( const AuthenticationTokens &  authenticationToken )

inlinevirtual

Event for PasswordGrantMultiFactorConfirm success.

Parameters

authenticationToken

Tokens on successful sign in.

OnPasswordGrantMultiFactorSignInFail()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnPasswordGrantMultiFactorSignInFail ( const AZStd::string &  error )

inlinevirtual

Event for PasswordGrantMultiFactorSignIn fail.

Parameters

error

Error message

OnPasswordGrantMultiFactorSignInSuccess()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnPasswordGrantMultiFactorSignInSuccess ( )

inlinevirtual

Event for PasswordGrantMultiFactorSignIn success. Event use to notify user to take corresponding challenge action.

OnPasswordGrantSingleFactorSignInFail()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnPasswordGrantSingleFactorSignInFail ( const AZStd::string &  error )

inlinevirtual

Event for PasswordGrantSingleFactorSignIn fail.

Parameters

error

Error message

OnPasswordGrantSingleFactorSignInSuccess()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnPasswordGrantSingleFactorSignInSuccess ( const AuthenticationTokens &  authenticationToken )

inlinevirtual

Event for PasswordGrantSingleFactorSignIn success.

Parameters

authenticationToken

Tokens on successful sign in.

OnRefreshTokensFail()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnRefreshTokensFail ( const AZStd::string &  error )

inlinevirtual

Event for RequestAccessTokenWithRefresh fail.

Parameters

error

Error message

OnRefreshTokensSuccess()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnRefreshTokensSuccess ( const AuthenticationTokens &  authenticationToken )

inlinevirtual

Event for RequestAccessTokenWithRefresh success.

Parameters

authenticationToken

Tokens on successful sign in.

OnSignOut()

virtual void AWSClientAuth::AuthenticationProviderNotifications::OnSignOut ( const ProviderNameEnum &  provideName )

inlinevirtual

Event for Sing out.

Parameters

providerName

provider that signed out.

---

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

• Gems/AWSClientAuth/Code/Include/Authentication/AuthenticationProviderBus.h