Abstract class for AWS Cognito authorization requests.
More...
#include <AWSCognitoAuthorizationBus.h>
Abstract class for AWS Cognito authorization requests.
◆ GetAnonymousCognitoCredentialsProvider()
virtual std::shared_ptr<Aws::Auth::AWSCredentialsProvider> AWSClientAuth::IAWSCognitoAuthorizationRequests::GetAnonymousCognitoCredentialsProvider |
( |
| ) |
|
|
pure virtual |
Returns anonymous AWSCredentialsProvider to initialize up AWS Native SDK clients. std::shared_ptr to allow sharing ownership with AWS Native SDK.
- Returns
- std::shared_ptr for Aws::Auth::AWSCredentialProvider.
◆ GetCognitoCredentialsProvider()
virtual std::shared_ptr<Aws::Auth::AWSCredentialsProvider> AWSClientAuth::IAWSCognitoAuthorizationRequests::GetCognitoCredentialsProvider |
( |
| ) |
|
|
pure virtual |
Returns AWSCredentialsProvider to initialize up AWS Native SDK clients. std::shared_ptr to allow sharing ownership with AWS Native SDK.
- Returns
- std::shared_ptr for Aws::Auth::AWSCredentialProvider.
◆ GetIdentityId()
virtual AZStd::string AWSClientAuth::IAWSCognitoAuthorizationRequests::GetIdentityId |
( |
| ) |
|
|
pure virtual |
Get cached Cognito identity id from last successful GetId call to Cognito.
- Returns
- Cognito identity id
◆ HasPersistedLogins()
virtual bool AWSClientAuth::IAWSCognitoAuthorizationRequests::HasPersistedLogins |
( |
| ) |
|
|
pure virtual |
Checks if logins are persisted.
- Returns
- True if logins persists else false.
◆ Initialize()
virtual bool AWSClientAuth::IAWSCognitoAuthorizationRequests::Initialize |
( |
| ) |
|
|
pure virtual |
Initializes settings for Cognito identity pool from settings registry.
- Parameters
-
settingsRegistryPath | Path for the settings registry file to use. |
◆ RequestAWSCredentialsAsync()
virtual void AWSClientAuth::IAWSCognitoAuthorizationRequests::RequestAWSCredentialsAsync |
( |
| ) |
|
|
pure virtual |
Get cached AWS credentials or fetch credentials from Cognito. Will fetch authenticated role credentials if login are cached else fetches unauthenticated role credentials if enabled in Cognito Identity pool. If multiple logins are persisted and no cached credentials found, GetId call to Cognito will link the login provider to same identity.
◆ Reset()
virtual void AWSClientAuth::IAWSCognitoAuthorizationRequests::Reset |
( |
| ) |
|
|
pure virtual |
Once credentials provider are set they cannot be reset. So recreates new Cognito credentials provider on reset. Service clients need to be created with the new AWSCredentialsProvider after reset.
The documentation for this class was generated from the following file:
- Gems/AWSClientAuth/Code/Include/Authorization/AWSCognitoAuthorizationBus.h