Module Awso_cognito_idp.GetUserAuthFactorsResponseSource

Lists the authentication options for the currently signed-in user. Returns the following: The user's multi-factor authentication (MFA) preferences. The user's options for choice-based authentication with the USER_AUTH flow. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. 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. username : UsernameType.t option;
    (*

    The name of the user who is eligible for the authentication factors in the response.

    *)
  2. preferredMfaSetting : StringType.t option;
    (*

    The challenge method that Amazon Cognito returns to the user in response to sign-in requests. Users can prefer SMS message, email message, or TOTP MFA.

    *)
  3. userMFASettingList : UserMFASettingListType.t option;
    (*

    The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

    *)
  4. configuredUserAuthFactors : ConfiguredUserAuthFactorsListType.t option;
    (*

    The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

    *)
}
Sourcetype nonrec error = [
  1. | `ForbiddenException of ForbiddenException.t
  2. | `InternalErrorException of InternalErrorException.t
  3. | `InvalidParameterException of InvalidParameterException.t
  4. | `NotAuthorizedException of NotAuthorizedException.t
  5. | `PasswordResetRequiredException of PasswordResetRequiredException.t
  6. | `ResourceNotFoundException of ResourceNotFoundException.t
  7. | `TooManyRequestsException of TooManyRequestsException.t
  8. | `UserNotConfirmedException of UserNotConfirmedException.t
  9. | `UserNotFoundException of UserNotFoundException.t
  10. | `Unknown_operation_error of string * string option
]
Sourceval make : ?username:??? -> ?preferredMfaSetting:??? -> ?userMFASettingList:??? -> ?configuredUserAuthFactors:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ForbiddenException of ForbiddenException.t | `InternalErrorException of InternalErrorException.t | `InvalidParameterException of InvalidParameterException.t | `NotAuthorizedException of NotAuthorizedException.t | `PasswordResetRequiredException of PasswordResetRequiredException.t | `ResourceNotFoundException of ResourceNotFoundException.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 -> [> `ForbiddenException of ForbiddenException.t | `InternalErrorException of InternalErrorException.t | `InvalidParameterException of InvalidParameterException.t | `NotAuthorizedException of NotAuthorizedException.t | `PasswordResetRequiredException of PasswordResetRequiredException.t | `ResourceNotFoundException of ResourceNotFoundException.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 * [> `List of [> `Enum of string | `String of StringType.t ] list | `String of UsernameType.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