AWSClientAuth::IAuthenticationProviderScriptCanvasRequests Class Reference

#include <AuthenticationProviderScriptCanvasBus.h>

Public Member Functions
	AZ_TYPE_INFO (IAuthenticationProviderScriptCanvasRequests, "{A8FD915F-9FF2-4BA3-8AA0-8CF7A94A323B}")
virtual bool	Initialize (const AZStd::vector< AZStd::string > &providerNames)=0
virtual bool	IsSignedIn (const AZStd::string &providerName)=0
virtual AuthenticationTokens	GetAuthenticationTokens (const AZStd::string &providerName)=0
virtual void	PasswordGrantSingleFactorSignInAsync (const AZStd::string &providerName, const AZStd::string &username, const AZStd::string &password)=0
virtual void	PasswordGrantMultiFactorSignInAsync (const AZStd::string &providerName, const AZStd::string &username, const AZStd::string &password)=0
virtual void	PasswordGrantMultiFactorConfirmSignInAsync (const AZStd::string &providerName, const AZStd::string &username, const AZStd::string &confirmationCode)=0
virtual void	DeviceCodeGrantSignInAsync (const AZStd::string &providerName)=0
virtual void	DeviceCodeGrantConfirmSignInAsync (const AZStd::string &providerName)=0
virtual void	RefreshTokensAsync (const AZStd::string &providerName)=0
virtual void	GetTokensWithRefreshAsync (const AZStd::string &providerName)=0
virtual bool	SignOut (const AZStd::string &providerName)=0

Detailed Description

Abstract class for authentication provider script canvas requests. Private class to allow provide names to be string type instead of an enum as behavior context does not work well with enum's.

Member Function Documentation

DeviceCodeGrantConfirmSignInAsync()

virtual void AWSClientAuth::IAuthenticationProviderScriptCanvasRequests::DeviceCodeGrantConfirmSignInAsync ( const AZStd::string &  providerName )

pure virtual

Call tokens endpoint for provider device grant flow.

Parameters

providerName

Provider to call device confirm sign in.

DeviceCodeGrantSignInAsync()

virtual void AWSClientAuth::IAuthenticationProviderScriptCanvasRequests::DeviceCodeGrantSignInAsync ( const AZStd::string &  providerName )

pure virtual

Call code-pair endpoint for provider device grant flow.

Parameters

providerName

Provider to call device sign in.

GetAuthenticationTokens()

virtual AuthenticationTokens AWSClientAuth::IAuthenticationProviderScriptCanvasRequests::GetAuthenticationTokens ( const AZStd::string &  providerName )

pure virtual

Get cached tokens from last last successful sign-in for the provider.

Parameters

providerName

Provider to get authentication tokens

Returns

AuthenticationTokens tokens from successful authentication.

GetTokensWithRefreshAsync()

virtual void AWSClientAuth::IAuthenticationProviderScriptCanvasRequests::GetTokensWithRefreshAsync ( const AZStd::string &  providerName )

pure virtual

Call refresh token if token not valid. If token valid, fires corresponding event.

Parameters

providerName

Provider to get access token for. events: OnRefreshTokensSuccess, OnRefreshTokensFail

Initialize()

virtual bool AWSClientAuth::IAuthenticationProviderScriptCanvasRequests::Initialize ( const AZStd::vector< AZStd::string > &  providerNames )

pure virtual

Parse the settings file for required settings for authentication providers. Instantiate and initialize authentication providers

Parameters

providerNames

List of provider names to instantiate and initialize for Authentication.

Returns

bool True: if all providers initialized successfully. False: If any provider fails initialization.

IsSignedIn()

virtual bool AWSClientAuth::IAuthenticationProviderScriptCanvasRequests::IsSignedIn ( const AZStd::string &  providerName )

pure virtual

Checks if user is signed in. If access tokens are available and not expired.

Parameters

providerName

Provider to check signed in for

Returns

bool True if valid access token available, else False

PasswordGrantMultiFactorConfirmSignInAsync()

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

pure virtual

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

Parameters

providerName	Provider to call MFA confirm sign in.
username	Username to use for MFA confirm.
confirmationCode	Confirmation code (sent to email/text) to use for MFA confirm.

PasswordGrantMultiFactorSignInAsync()

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

pure virtual

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

Parameters

providerName	Provider to call MFA sign in.
username	Username to use for MFA sign in.
password	Password to use for MFA sign in.

PasswordGrantSingleFactorSignInAsync()

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

pure virtual

Call sign in endpoint for provider password grant flow.

Parameters

providerName	Provider to call sign in.
username	Username to use to for sign in.
password	Password to use to for sign in.

RefreshTokensAsync()

virtual void AWSClientAuth::IAuthenticationProviderScriptCanvasRequests::RefreshTokensAsync ( const AZStd::string &  providerName )

pure virtual

Call refresh endpoint for provider refresh grant flow.

Parameters

providerName

Provider to call refresh tokens.

SignOut()

virtual bool AWSClientAuth::IAuthenticationProviderScriptCanvasRequests::SignOut ( const AZStd::string &  providerName )

pure virtual

Signs user out. Clears all cached tokens.

Parameters

providerName

Provider to sign out.

Returns

bool True: Successfully sign out.

---

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

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