com.amazonaws.mobileconnectors.cognitoauth

Class Auth

java.lang.Object

com.amazonaws.mobileconnectors.cognitoauth.Auth

public final class Auth
extends java.lang.Object

Abstraction for Cognito Auth, provides methods to authenticate users in a User-Pool.

Provides methods to get tokens, retrieve the last authenticated user on the device, and sign-out users.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Auth.Builder Builder class for Auth objects.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAppId()
java.lang.String	getAppSecret()
java.lang.String	getAppWebDomain()
java.lang.String	getBrowserPackage()
Auth	getCurrentUser()
android.os.Bundle	getCustomTabExtras()
java.lang.String	getIdentityProvider()
java.lang.String	getIdpIdentifier()
java.util.Set<java.lang.String>	getScopes()
void	getSession(android.app.Activity activity) Use this method to get tokens for a user, the tokens are returned though the callback.
void	getSessionWithoutWebUI() Use this method to get tokens for a user, the tokens are returned though the callback.
java.lang.String	getSignInRedirectUri()
java.lang.String	getSignOutRedirectUri()
void	getTokens(android.net.Uri uri) Exchanges the Cognito Authentication Code for Cognito Tokens.
java.lang.String	getUsername()
java.lang.String	getUserPoolId()
void	handleFlowCancelled() Properly handles the event where a user cancels the auth flow before completing it.
boolean	isAdvancedSecurityDataCollectionEnabled()
boolean	isAuthenticated()
void	release() Release resources used by Auth
void	setAdvancedSecurityDataCollection(boolean isEnabled) It enables user context data collection.
void	setAuthHandler(AuthHandler authHandler) Reset the AuthHandler on the client.
void	setBrowserPackage(java.lang.String browserPackage) Update the browser package to use for launching a custom tab.
void	setPersistenceEnabled(boolean isPersistenceEnabled) Enable or disable persistence
Auth	setUsername(java.lang.String username) Set a username for the Auth instance.
void	signOut() Signs out the user.
void	signOut(boolean clearLocalTokensOnly) Sign out with options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setAdvancedSecurityDataCollection

public void setAdvancedSecurityDataCollection(boolean isEnabled)

It enables user context data collection.

isAdvancedSecurityDataCollectionEnabled

public boolean isAdvancedSecurityDataCollectionEnabled()

Returns:

It identifies if the data collection is enabled. By default, we do collect user context data.

setPersistenceEnabled

public void setPersistenceEnabled(boolean isPersistenceEnabled)

Enable or disable persistence

Parameters:

isPersistenceEnabled - flag if true indicates tokens are persisted.

setBrowserPackage

public void setBrowserPackage(java.lang.String browserPackage)

Update the browser package to use for launching a custom tab.

Parameters:

browserPackage - the browser package to use for launching a custom tab.

getCurrentUser

public Auth getCurrentUser()

Returns:

an instance of Auth after setting to the last authenticated user on the device.

getUserPoolId

public java.lang.String getUserPoolId()

Returns:

Id for the cognito user pool used by the application.

getAppWebDomain

public java.lang.String getAppWebDomain()

Returns:

the web domain set for this application.

getAppId

public java.lang.String getAppId()

Returns:

the Cognito Client App-Id set for this application.

getAppSecret

public java.lang.String getAppSecret()

Returns:

the Cognito Client App-Secret.

getScopes

public java.util.Set<java.lang.String> getScopes()

Returns:

Scopes set for this Auth instance.

getUsername

public java.lang.String getUsername()

Returns:

The username set for this Auth instance.

getSignInRedirectUri

public java.lang.String getSignInRedirectUri()

Returns:

Sign-In redirect uri set for this Auth instance.

getSignOutRedirectUri

public java.lang.String getSignOutRedirectUri()

Returns:

Sign-Out redirect uri set for this Auth instance.

getBrowserPackage

public java.lang.String getBrowserPackage()

Returns:

Optional browser package set for this Auth instance.

getIdentityProvider

public java.lang.String getIdentityProvider()

Returns:

Identity Provider set for this Auth instance.

getIdpIdentifier

public java.lang.String getIdpIdentifier()

Returns:

Identity Provider identifier set for this Auth instance.

getCustomTabExtras

public android.os.Bundle getCustomTabExtras()

Returns:

Extra customization bundle for this Auth instance.

getSession

public void getSession(android.app.Activity activity)

Use this method to get tokens for a user, the tokens are returned though the callback. AuthHandler.onSuccess(AuthUserSession).

If a username is available, this method looks for valid cached tokens on the device. If the cached token have expired and the refresh token (if available) is used to get new tokens. If valid tokens are not available locally or if the username is not set, Cognito Auth's web interface is launched on Chrome Custom Tabs. The user credentials will be required to authenticate. Note: This SDK uses OAuth Code-Grant flow with PKCE, for authentication. To get tokens after successful user authentication, the Amazon Cognito Auth returns the authentication code through the redirect uri. Call getTokens(Uri) to get tokens from the authentication code. Uri is the redirect uri with the authentication code.

Parameters:

activity - Activity to launch custom tabs from and to listen for the intent completions.

getSessionWithoutWebUI

public void getSessionWithoutWebUI()

Use this method to get tokens for a user, the tokens are returned though the callback. AuthHandler.onSuccess(AuthUserSession). If the tokens are not available, it will not launch the browser to re-authenticate.

If a username is available, this method looks for valid cached tokens on the device. If the cached token have expired and the refresh token (if available) is used to get new tokens. If valid tokens are not available locally or if the username is not set, the error callback will be invoked. It will not launch a sign in experience.

setAuthHandler

public void setAuthHandler(AuthHandler authHandler)

Reset the AuthHandler on the client.

Parameters:

authHandler -

signOut

public void signOut()

Signs out the user.

Invokes Cognito Auth's web signout domain to clear cookies stored. If username is set, the local cached tokens are cleared.

signOut

public void signOut(boolean clearLocalTokensOnly)

Sign out with options.

Parameters:

clearLocalTokensOnly - true if signs out the user from the client, but the session may still be alive from the browser.

isAuthenticated

public boolean isAuthenticated()

Returns:

True if a user has valid cached tokens.

getTokens

public void getTokens(android.net.Uri uri)

Exchanges the Cognito Authentication Code for Cognito Tokens.

Call this method when the Chrome Custom tabs redirect to the your app Activity after authentication. Pass the redirect uri as parameter, the redirect uri can can be found in the Intent used to invoke your Activity.

Parameters:

uri - Required: Uri containing the redirect and authentication code.

handleFlowCancelled

public void handleFlowCancelled()

Properly handles the event where a user cancels the auth flow before completing it.

setUsername

public Auth setUsername(java.lang.String username)

Set a username for the Auth instance.

Parameters:

username - Required: The username of the user in your Cognito User-Pool.

Returns:

Auth.

release

public void release()

Release resources used by Auth