AWSCognitoIdentityProviderAdminInitiateAuthRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSCognitoIdentityProviderModel.h
AWSCognitoIdentityProviderModel.m

Overview

Initiates the authorization request, as an administrator.

Required parameters: [UserPoolId, ClientId, AuthFlow]

  analyticsMetadata

The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

@property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType *analyticsMetadata

Declared In

AWSCognitoIdentityProviderModel.h

  authFlow

The authentication flow for this call to execute. The API action will depend on this value. For example:

  • REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

  • USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.

Valid values include:

  • USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

  • REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

  • CUSTOM_AUTH: Custom authentication flow.

  • ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

@property (nonatomic, assign) AWSCognitoIdentityProviderAuthFlowType authFlow

Declared In

AWSCognitoIdentityProviderModel.h

  authParameters

The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:

  • For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

  • For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: USERNAME (required), SECRET_HASH (required if the app client is configured with a client secret), REFRESH_TOKEN (required), DEVICE_KEY

  • For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY

  • For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY

@property (nonatomic, strong) NSDictionary<NSString*NSString*> *authParameters

Declared In

AWSCognitoIdentityProviderModel.h

  clientId

The app client ID.

@property (nonatomic, strong) NSString *clientId

Declared In

AWSCognitoIdentityProviderModel.h

  clientMetadata

This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.

@property (nonatomic, strong) NSDictionary<NSString*NSString*> *clientMetadata

Declared In

AWSCognitoIdentityProviderModel.h

  contextData

@property (nonatomic, strong) AWSCognitoIdentityProviderContextDataType *contextData

Declared In

AWSCognitoIdentityProviderModel.h

  userPoolId

The ID of the Amazon Cognito user pool.

@property (nonatomic, strong) NSString *userPoolId

Declared In

AWSCognitoIdentityProviderModel.h