Module Awso_cognito_idp.VerifySoftwareTokenResponseSource

Registers the current user's time-based one-time password (TOTP) authenticator with a code generated in their authenticator app from a private key that's supplied by your user pool. Marks the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both. Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Sourcetype nonrec t = {
  1. status : VerifySoftwareTokenResponseType.t option;
    (*

    Amazon Cognito can accept or reject the code that you provide. This response parameter indicates the success of TOTP verification. Some reasons that this operation might return an error are clock skew on the user's device and excessive retries.

    *)
  2. session : SessionType.t option;
    (*

    This session ID satisfies an MFA_SETUP challenge. Supply the session ID in your challenge response.

    *)
}
Sourcetype nonrec error = [
  1. | `CodeMismatchException of CodeMismatchException.t
  2. | `EnableSoftwareTokenMFAException of EnableSoftwareTokenMFAException.t
  3. | `ForbiddenException of ForbiddenException.t
  4. | `InternalErrorException of InternalErrorException.t
  5. | `InvalidParameterException of InvalidParameterException.t
  6. | `InvalidUserPoolConfigurationException of InvalidUserPoolConfigurationException.t
  7. | `NotAuthorizedException of NotAuthorizedException.t
  8. | `PasswordResetRequiredException of PasswordResetRequiredException.t
  9. | `ResourceNotFoundException of ResourceNotFoundException.t
  10. | `SoftwareTokenMFANotFoundException of SoftwareTokenMFANotFoundException.t
  11. | `TooManyRequestsException of TooManyRequestsException.t
  12. | `UserNotConfirmedException of UserNotConfirmedException.t
  13. | `UserNotFoundException of UserNotFoundException.t
  14. | `Unknown_operation_error of string * string option
]
Sourceval make : ?status:??? -> ?session:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `CodeMismatchException of CodeMismatchException.t | `EnableSoftwareTokenMFAException of EnableSoftwareTokenMFAException.t | `ForbiddenException of ForbiddenException.t | `InternalErrorException of InternalErrorException.t | `InvalidParameterException of InvalidParameterException.t | `InvalidUserPoolConfigurationException of InvalidUserPoolConfigurationException.t | `NotAuthorizedException of NotAuthorizedException.t | `PasswordResetRequiredException of PasswordResetRequiredException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `SoftwareTokenMFANotFoundException of SoftwareTokenMFANotFoundException.t | `TooManyRequestsException of TooManyRequestsException.t | `Unknown_operation_error of string * string option | `UserNotConfirmedException of UserNotConfirmedException.t | `UserNotFoundException of UserNotFoundException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `CodeMismatchException of CodeMismatchException.t | `EnableSoftwareTokenMFAException of EnableSoftwareTokenMFAException.t | `ForbiddenException of ForbiddenException.t | `InternalErrorException of InternalErrorException.t | `InvalidParameterException of InvalidParameterException.t | `InvalidUserPoolConfigurationException of InvalidUserPoolConfigurationException.t | `NotAuthorizedException of NotAuthorizedException.t | `PasswordResetRequiredException of PasswordResetRequiredException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `SoftwareTokenMFANotFoundException of SoftwareTokenMFANotFoundException.t | `TooManyRequestsException of TooManyRequestsException.t | `Unknown_operation_error of string * string option | `UserNotConfirmedException of UserNotConfirmedException.t | `UserNotFoundException of UserNotFoundException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of SessionType.t ]) 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