Skip to main content

ICognitoIdentityProviderAdminInitiateAuthResponse

Interface in AWS.CognitoIdentityProvider

Interface for AdminInitiateAuth responses.

Ancestors

Properties

AuthenticationResult

property AuthenticationResult: ICognitoIdentityProviderAuthenticationResultType

Type: ICognitoIdentityProviderAuthenticationResultType

The result of the authentication response.

This is only returned if the caller doesn't need to pass another challenge.

ChallengeName

property ChallengeName: string

The name of the challenge that you're responding to with this call.

This is returned if you must pass another challenge. Valid values:

ChallengeParameters

property ChallengeParameters: TDictionary<string, string>

The challenge parameters.

The responses in this parameter should be used to compute inputs to the next call AdminRespondToAuthChallenge). The value of the USER_ID_FOR_SRP attribute is the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This happens because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute can't be an alias.

Session

property Session: string

The session that should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call.