AWSCognitoIdentityProviderAdminInitiateAuthResponse
Objective-C
@interface AWSCognitoIdentityProviderAdminInitiateAuthResponse
Swift
class AWSCognitoIdentityProviderAdminInitiateAuthResponse
Initiates the authentication response, as an administrator.
-
The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens,
ChallengeName
,ChallengeParameters
, andSession
are returned.Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderAuthenticationResultType *_Nullable authenticationResult;
Swift
var authenticationResult: AWSCognitoIdentityProviderAuthenticationResultType? { get set }
-
The name of the challenge which you are responding to with this call. This is returned to you in the
AdminInitiateAuth
response if you need to pass another challenge.MFA_SETUP
: If MFA is required, users who do not have at least one of the MFA methods set up are presented with anMFA_SETUP
challenge. The user must set up at least one MFA type to continue to authenticate.SELECT_MFA_TYPE
: Selects the MFA type. Valid MFA options areSMS_MFA
for text SMS MFA, andSOFTWARE_TOKEN_MFA
for TOTP software token MFA.SMS_MFA
: Next challenge is to supply anSMS_MFA_CODE
, delivered via SMS.PASSWORD_VERIFIER
: Next challenge is to supplyPASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
, andTIMESTAMP
after the client-side SRP calculations.CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.DEVICE_SRP_AUTH
: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.DEVICE_PASSWORD_VERIFIER
: Similar toPASSWORD_VERIFIER
, but for devices only.ADMIN_NO_SRP_AUTH
: This is returned if you need to authenticate withUSERNAME
andPASSWORD
directly. An app client must be enabled to use this flow.NEW_PASSWORD_REQUIRED
: For users which are required to change their passwords after successful first login. This challenge should be passed withNEW_PASSWORD
and any other required attributes.
Declaration
Objective-C
@property (nonatomic) AWSCognitoIdentityProviderChallengeNameType challengeName;
Swift
var challengeName: AWSCognitoIdentityProviderChallengeNameType { get set }
-
The challenge parameters. These are returned to you in the
AdminInitiateAuth
response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge
).All challenges require
USERNAME
andSECRET_HASH
(if applicable).The value of the
USER_ID_FOR_SRP
attribute will be the user’s actual username, not an alias (such as email address or phone number), even if you specified an alias in your call toAdminInitiateAuth
. This is because, in theAdminRespondToAuthChallenge
APIChallengeResponses
, theUSERNAME
attribute cannot be an alias.Declaration
Objective-C
@property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable challengeParameters;
Swift
var challengeParameters: [String : String]? { get set }
-
The session which should be passed both ways in challenge-response calls to the service. If
AdminInitiateAuth
orAdminRespondToAuthChallenge
API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the nextAdminRespondToAuthChallenge
API call.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable session;
Swift
var session: String? { get set }