InitiateAuthResponse (p.awso.0.9.1.doc.awso.cognito-idp.Awso_cognito

Sourcetype nonrec t = {

challengeName : ChallengeNameType.t option;
(*
The name of an additional authentication challenge that you must respond to. Possible challenges include the following: All of the following challenges require USERNAME and, when the app client has a client secret, SECRET_HASH in the parameters. Include a DEVICE_KEY for device authentication. WEB_AUTHN: Respond to the challenge with the results of a successful authentication with a WebAuthn authenticator, or passkey, as CREDENTIAL. Examples of WebAuthn authenticators include biometric devices and security keys. PASSWORD: Respond with the user's password as PASSWORD. PASSWORD_SRP: Respond with the initial SRP secret as SRP_A. SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. It must be one of the challenge types in the AvailableChallenges response parameter. Add the parameters of the selected challenge, for example USERNAME and SMS_OTP. SMS_MFA: Respond with the code that your user pool delivered in an SMS message, as SMS_MFA_CODE EMAIL_MFA: Respond with the code that your user pool delivered in an email message, as EMAIL_MFA_CODE EMAIL_OTP: Respond with the code that your user pool delivered in an email message, as EMAIL_OTP_CODE . SMS_OTP: Respond with the code that your user pool delivered in an SMS message, as SMS_OTP_CODE. PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP. CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. The parameters of the challenge are determined by your Lambda function and issued in the ChallengeParameters of a challenge response. DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP authentication. For more information, see Signing in with a device. DEVICE_PASSWORD_VERIFIER: Respond with PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after client-side SRP calculations. For more information, see Signing in with a device. NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. Amazon Cognito only returns this challenge for users who have temporary passwords. When you create passwordless users, you must provide values for all required attributes. In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API operation to modify the value of any additional attributes. MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFAS_CAN_SETUP value. To set up time-based one-time password (TOTP) MFA, use the session returned in this challenge from InitiateAuth or AdminInitiateAuth as an input to AssociateSoftwareToken. Then, use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge or AdminRespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS or email MFA, collect a phone_number or email attribute for the user. Then restart the authentication flow with an InitiateAuth or AdminInitiateAuth request.
*)
session : SessionType.t option;
(*
The session identifier that links a challenge response to the initial authentication request. If the user must pass another challenge, Amazon Cognito returns a session ID and challenge parameters.
*)
challengeParameters : ChallengeParametersType.t option;
(*
The required parameters of the ChallengeName challenge. All challenges require USERNAME. They also require SECRET_HASH if your app client has a client secret.
*)
authenticationResult : AuthenticationResultType.t option;
(*
The result of a successful and complete authentication request. This result is only returned if the user doesn't need to pass another challenge. If they must pass another challenge before they get tokens, Amazon Cognito returns a challenge in ChallengeName, ChallengeParameters, and Session response parameters.
*)
availableChallenges : AvailableChallengeListType.t option;
(*
This response parameter lists the available authentication challenges that users can select from in choice-based authentication. For example, they might be able to choose between passkey authentication, a one-time password from an SMS message, and a traditional password.
*)

}

Sourcetype nonrec error = [

| `ForbiddenException of ForbiddenException.t
| `InternalErrorException of InternalErrorException.t
| `InvalidEmailRoleAccessPolicyException of InvalidEmailRoleAccessPolicyException.t
| `InvalidLambdaResponseException of InvalidLambdaResponseException.t
| `InvalidParameterException of InvalidParameterException.t
| `InvalidSmsRoleAccessPolicyException of InvalidSmsRoleAccessPolicyException.t
| `InvalidSmsRoleTrustRelationshipException of InvalidSmsRoleTrustRelationshipException.t
| `InvalidUserPoolConfigurationException of InvalidUserPoolConfigurationException.t
| `NotAuthorizedException of NotAuthorizedException.t
| `PasswordResetRequiredException of PasswordResetRequiredException.t
| `ResourceNotFoundException of ResourceNotFoundException.t
| `TooManyRequestsException of TooManyRequestsException.t
| `UnexpectedLambdaException of UnexpectedLambdaException.t
| `UnsupportedOperationException of UnsupportedOperationException.t
| `UserLambdaValidationException of UserLambdaValidationException.t
| `UserNotConfirmedException of UserNotConfirmedException.t
| `UserNotFoundException of UserNotFoundException.t
| `Unknown_operation_error of string * string option

]

val make : 
  ?challengeName:??? ->
  ?session:??? ->
  ?challengeParameters:??? ->
  ?authenticationResult:??? ->
  ?availableChallenges:??? ->
  unit ->
  t

Source

val error_of_json : 
  string ->
  Yojson.Safe.t ->
  [> `ForbiddenException of ForbiddenException.t
  | `InternalErrorException of InternalErrorException.t
  | `InvalidEmailRoleAccessPolicyException of
    InvalidEmailRoleAccessPolicyException.t
  | `InvalidLambdaResponseException of InvalidLambdaResponseException.t
  | `InvalidParameterException of InvalidParameterException.t
  | `InvalidSmsRoleAccessPolicyException of
    InvalidSmsRoleAccessPolicyException.t
  | `InvalidSmsRoleTrustRelationshipException of
    InvalidSmsRoleTrustRelationshipException.t
  | `InvalidUserPoolConfigurationException of
    InvalidUserPoolConfigurationException.t
  | `NotAuthorizedException of NotAuthorizedException.t
  | `PasswordResetRequiredException of PasswordResetRequiredException.t
  | `ResourceNotFoundException of ResourceNotFoundException.t
  | `TooManyRequestsException of TooManyRequestsException.t
  | `UnexpectedLambdaException of UnexpectedLambdaException.t
  | `Unknown_operation_error of string * string option
  | `UnsupportedOperationException of UnsupportedOperationException.t
  | `UserLambdaValidationException of UserLambdaValidationException.t
  | `UserNotConfirmedException of UserNotConfirmedException.t
  | `UserNotFoundException of UserNotFoundException.t ]

Source

val error_of_xml : 
  string ->
  Awso.Xml.t ->
  [> `ForbiddenException of ForbiddenException.t
  | `InternalErrorException of InternalErrorException.t
  | `InvalidEmailRoleAccessPolicyException of
    InvalidEmailRoleAccessPolicyException.t
  | `InvalidLambdaResponseException of InvalidLambdaResponseException.t
  | `InvalidParameterException of InvalidParameterException.t
  | `InvalidSmsRoleAccessPolicyException of
    InvalidSmsRoleAccessPolicyException.t
  | `InvalidSmsRoleTrustRelationshipException of
    InvalidSmsRoleTrustRelationshipException.t
  | `InvalidUserPoolConfigurationException of
    InvalidUserPoolConfigurationException.t
  | `NotAuthorizedException of NotAuthorizedException.t
  | `PasswordResetRequiredException of PasswordResetRequiredException.t
  | `ResourceNotFoundException of ResourceNotFoundException.t
  | `TooManyRequestsException of TooManyRequestsException.t
  | `UnexpectedLambdaException of UnexpectedLambdaException.t
  | `Unknown_operation_error of string * string option
  | `UnsupportedOperationException of UnsupportedOperationException.t
  | `UserLambdaValidationException of UserLambdaValidationException.t
  | `UserNotConfirmedException of UserNotConfirmedException.t
  | `UserNotFoundException of UserNotFoundException.t ]

Sourceval error_to_json : error -> Yojson.Safe.t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `Enum of string
          | `List of [> `Enum of string ] list
          | `Map of
            ([> `String of StringType.t ] * [> `String of StringType.t ]) list
          | `String of SessionType.t
          | `Structure of
            (string
             * [> `Integer of IntegerType.t
               | `String of TokenModelType.t
               | `Structure of (string * [> `String of DeviceKeyType.t ]) list ])
              list ])
         list ]

Sourceval to_query : t -> Awso.Client.Query.t

Sourceval of_xml : Awso.Xml.t -> t

Sourceval of_string : string -> t

Sourceval of_json : Yojson.Safe.t -> t

Sourceval to_json : t -> Yojson.Safe.t