AWSCognitoIdentityUserPool Class Reference

Inherits from NSObject
Conforms to AWSIdentityProvider
AWSIdentityProviderManager
Declared in AWSCognitoIdentityUserPool.h
AWSCognitoIdentityUserPool.m

Other Methods

  identityProviderName

The name of the identity provider. e.g. graph.facebook.com.

@property (nonatomic, readonly) NSString *identityProviderName

Declared In

AWSIdentityProvider.h

  delegate

Set this delegate to interactively prompt users for authentication challenges when necessary

@property (nonatomic, strong) id<AWSCognitoIdentityInteractiveAuthenticationDelegate> delegate

Declared In

AWSCognitoIdentityUserPool.h

+ defaultCognitoIdentityUserPool

Fetches the Cognito User Pool instance configured in the info.plist under CognitoUserPool

+ (instancetype)defaultCognitoIdentityUserPool

Return Value

the default instance for Cognito User Pool

Declared In

AWSCognitoIdentityUserPool.h

– signUp:password:userAttributes:validationData:

Sign up a new user

- (AWSTask<AWSCognitoIdentityUserPoolSignUpResponse*> *)signUp:(NSString *)username password:(NSString *)password userAttributes:(nullable NSArray<AWSCognitoIdentityUserAttributeType*> *)userAttributes validationData:(nullable NSArray<AWSCognitoIdentityUserAttributeType*> *)validationData

Declared In

AWSCognitoIdentityUserPool.h

– currentUser

Return the user who last authenticated. Username may be nil if current user is unknown.

- (nullable AWSCognitoIdentityUser *)currentUser

Return Value

The last authenticated user

Declared In

AWSCognitoIdentityUserPool.h

– getUser

Return the user without a username, when username is unknown.

- (AWSCognitoIdentityUser *)getUser

Declared In

AWSCognitoIdentityUserPool.h

– getUser:

Return the user with a specific username

- (AWSCognitoIdentityUser *)getUser:(NSString *)username

Declared In

AWSCognitoIdentityUserPool.h

– clearLastKnownUser

Clear the last known user only without signing out of their user session

- (void)clearLastKnownUser

Declared In

AWSCognitoIdentityUserPool.h

– clearAll

Clear everything from keychain, including last known user and user sessions for all users.

- (void)clearAll

Declared In

AWSCognitoIdentityUserPool.h

Other Methods

– token

Returns the token associated with this provider. If the token is cached and invalid, should refresh and return the valid token.

- (AWSTask<NSString*> *)token

Declared In

AWSIdentityProvider.h

– logins

Each entry in logins represents a single login with an identity provider. The key is the domain of the login provider (e.g. ‘graph.facebook.com’) and the value is the OAuth/OpenId Connect token that results from an authentication with that login provider.

- (AWSTask<NSDictionary<NSString*,NSString*> *> *)logins

Declared In

AWSIdentityProvider.h