Amazon Cognito Identity Provider
  1. Schemas
Amazon Cognito Identity Provider
  • Root
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
    • /
  • Schemas
    • Schemas
      • AddCustomAttributesResponse
      • AddCustomAttributesRequest
      • ResourceNotFoundException
      • InvalidParameterException
      • TooManyRequestsException
      • NotAuthorizedException
      • UserImportInProgressException
      • InternalErrorException
      • AdminAddUserToGroupRequest
      • UserNotFoundException
      • AdminConfirmSignUpResponse
      • AdminConfirmSignUpRequest
      • UnexpectedLambdaException
      • UserLambdaValidationException
      • TooManyFailedAttemptsException
      • InvalidLambdaResponseException
      • LimitExceededException
      • AdminCreateUserResponse
      • AdminCreateUserRequest
      • UsernameExistsException
      • InvalidPasswordException
      • CodeDeliveryFailureException
      • PreconditionNotMetException
      • InvalidSmsRoleAccessPolicyException
      • InvalidSmsRoleTrustRelationshipException
      • UnsupportedUserStateException
      • AdminDeleteUserRequest
      • AdminDeleteUserAttributesResponse
      • AdminDeleteUserAttributesRequest
      • AdminDisableProviderForUserResponse
      • AdminDisableProviderForUserRequest
      • AliasExistsException
      • AdminDisableUserResponse
      • AdminDisableUserRequest
      • AdminEnableUserResponse
      • AdminEnableUserRequest
      • AdminForgetDeviceRequest
      • InvalidUserPoolConfigurationException
      • AdminGetDeviceResponse
      • AdminGetDeviceRequest
      • AdminGetUserResponse
      • AdminGetUserRequest
      • AdminInitiateAuthResponse
      • AdminInitiateAuthRequest
      • MFAMethodNotFoundException
      • PasswordResetRequiredException
      • UserNotConfirmedException
      • AdminLinkProviderForUserResponse
      • AdminLinkProviderForUserRequest
      • AdminListDevicesResponse
      • AdminListDevicesRequest
      • AdminListGroupsForUserResponse
      • AdminListGroupsForUserRequest
      • AdminListUserAuthEventsResponse
      • AdminListUserAuthEventsRequest
      • UserPoolAddOnNotEnabledException
      • AdminRemoveUserFromGroupRequest
      • AdminResetUserPasswordResponse
      • AdminResetUserPasswordRequest
      • InvalidEmailRoleAccessPolicyException
      • AdminRespondToAuthChallengeResponse
      • AdminRespondToAuthChallengeRequest
      • CodeMismatchException
      • ExpiredCodeException
      • SoftwareTokenMFANotFoundException
      • AdminSetUserMFAPreferenceResponse
      • AdminSetUserMFAPreferenceRequest
      • AdminSetUserPasswordResponse
      • AdminSetUserPasswordRequest
      • AdminSetUserSettingsResponse
      • AdminSetUserSettingsRequest
      • AdminUpdateAuthEventFeedbackResponse
      • AdminUpdateAuthEventFeedbackRequest
      • AdminUpdateDeviceStatusResponse
      • AdminUpdateDeviceStatusRequest
      • AdminUpdateUserAttributesResponse
      • AdminUpdateUserAttributesRequest
      • AdminUserGlobalSignOutResponse
      • AdminUserGlobalSignOutRequest
      • AssociateSoftwareTokenResponse
      • AssociateSoftwareTokenRequest
      • ConcurrentModificationException
      • ChangePasswordResponse
      • ForbiddenException
      • ChangePasswordRequest
      • ConfirmDeviceResponse
      • ConfirmDeviceRequest
      • ConfirmForgotPasswordResponse
      • ConfirmForgotPasswordRequest
      • ConfirmSignUpResponse
      • ConfirmSignUpRequest
      • CreateGroupResponse
      • CreateGroupRequest
      • GroupExistsException
      • CreateIdentityProviderResponse
      • CreateIdentityProviderRequest
      • DuplicateProviderException
      • CreateResourceServerResponse
      • CreateResourceServerRequest
      • CreateUserImportJobResponse
      • CreateUserImportJobRequest
      • CreateUserPoolResponse
      • CreateUserPoolRequest
      • UserPoolTaggingException
      • CreateUserPoolClientResponse
      • CreateUserPoolClientRequest
      • ScopeDoesNotExistException
      • InvalidOAuthFlowException
      • CreateUserPoolDomainResponse
      • CreateUserPoolDomainRequest
      • DeleteGroupRequest
      • DeleteIdentityProviderRequest
      • UnsupportedIdentityProviderException
      • DeleteResourceServerRequest
      • DeleteUserRequest
      • DeleteUserAttributesResponse
      • DeleteUserAttributesRequest
      • DeleteUserPoolRequest
      • DeleteUserPoolClientRequest
      • DeleteUserPoolDomainResponse
      • DeleteUserPoolDomainRequest
      • DescribeIdentityProviderResponse
      • DescribeIdentityProviderRequest
      • DescribeResourceServerResponse
      • DescribeResourceServerRequest
      • DescribeRiskConfigurationResponse
      • DescribeRiskConfigurationRequest
      • DescribeUserImportJobResponse
      • DescribeUserImportJobRequest
      • DescribeUserPoolResponse
      • DescribeUserPoolRequest
      • DescribeUserPoolClientResponse
      • DescribeUserPoolClientRequest
      • DescribeUserPoolDomainResponse
      • DescribeUserPoolDomainRequest
      • ForgetDeviceRequest
      • ForgotPasswordResponse
      • ForgotPasswordRequest
      • GetCSVHeaderResponse
      • GetCSVHeaderRequest
      • GetDeviceResponse
      • GetDeviceRequest
      • GetGroupResponse
      • GetGroupRequest
      • GetIdentityProviderByIdentifierResponse
      • GetIdentityProviderByIdentifierRequest
      • GetSigningCertificateResponse
      • GetSigningCertificateRequest
      • GetUICustomizationResponse
      • GetUICustomizationRequest
      • GetUserResponse
      • GetUserRequest
      • GetUserAttributeVerificationCodeResponse
      • GetUserAttributeVerificationCodeRequest
      • GetUserPoolMfaConfigResponse
      • GetUserPoolMfaConfigRequest
      • GlobalSignOutResponse
      • GlobalSignOutRequest
      • InitiateAuthResponse
      • InitiateAuthRequest
      • ListDevicesResponse
      • ListDevicesRequest
      • ListGroupsResponse
      • ListGroupsRequest
      • ListIdentityProvidersResponse
      • ListIdentityProvidersRequest
      • ListResourceServersResponse
      • ListResourceServersRequest
      • ListTagsForResourceResponse
      • ListTagsForResourceRequest
      • ListUserImportJobsResponse
      • ListUserImportJobsRequest
      • ListUserPoolClientsResponse
      • ListUserPoolClientsRequest
      • ListUserPoolsResponse
      • ListUserPoolsRequest
      • ListUsersResponse
      • ListUsersRequest
      • ListUsersInGroupResponse
      • ListUsersInGroupRequest
      • ResendConfirmationCodeResponse
      • ResendConfirmationCodeRequest
      • RespondToAuthChallengeResponse
      • RespondToAuthChallengeRequest
      • RevokeTokenResponse
      • RevokeTokenRequest
      • UnauthorizedException
      • UnsupportedOperationException
      • UnsupportedTokenTypeException
      • SetRiskConfigurationResponse
      • SetRiskConfigurationRequest
      • SetUICustomizationResponse
      • SetUICustomizationRequest
      • SetUserMFAPreferenceResponse
      • SetUserMFAPreferenceRequest
      • SetUserPoolMfaConfigResponse
      • SetUserPoolMfaConfigRequest
      • SetUserSettingsResponse
      • SetUserSettingsRequest
      • SignUpResponse
      • SignUpRequest
      • StartUserImportJobResponse
      • StartUserImportJobRequest
      • StopUserImportJobResponse
      • StopUserImportJobRequest
      • TagResourceResponse
      • TagResourceRequest
      • UntagResourceResponse
      • UntagResourceRequest
      • UpdateAuthEventFeedbackResponse
      • UpdateAuthEventFeedbackRequest
      • UpdateDeviceStatusResponse
      • UpdateDeviceStatusRequest
      • UpdateGroupResponse
      • UpdateGroupRequest
      • UpdateIdentityProviderResponse
      • UpdateIdentityProviderRequest
      • UpdateResourceServerResponse
      • UpdateResourceServerRequest
      • UpdateUserAttributesResponse
      • UpdateUserAttributesRequest
      • UpdateUserPoolResponse
      • UpdateUserPoolRequest
      • UpdateUserPoolClientResponse
      • UpdateUserPoolClientRequest
      • UpdateUserPoolDomainResponse
      • UpdateUserPoolDomainRequest
      • VerifySoftwareTokenResponse
      • VerifySoftwareTokenRequest
      • EnableSoftwareTokenMFAException
      • VerifyUserAttributeResponse
      • VerifyUserAttributeRequest
      • AWSAccountIdType
      • AccessTokenValidityType
      • RecoveryMechanismsType
      • AccountRecoverySettingType
      • AccountTakeoverActionNotifyType
      • AccountTakeoverEventActionType
      • AccountTakeoverActionType
      • AccountTakeoverActionsType
      • NotifyConfigurationType
      • AccountTakeoverRiskConfigurationType
      • UserPoolIdType
      • CustomAttributesListType
      • UsernameType
      • GroupNameType
      • ClientMetadataType
      • BooleanType
      • AdminCreateUserUnusedAccountValidityDaysType
      • MessageTemplateType
      • AdminCreateUserConfigType
      • AttributeListType
      • PasswordType
      • ForceAliasCreation
      • MessageActionType
      • DeliveryMediumListType
      • UserType
      • AttributeNameListType
      • StringType
      • ProviderUserIdentifierType
      • DeviceKeyType
      • DeviceType
      • DateType
      • UserStatusType
      • MFAOptionListType
      • UserMFASettingListType
      • ClientIdType
      • AuthFlowType
      • AuthParametersType
      • AnalyticsMetadataType
      • ContextDataType
      • ChallengeNameType
      • SessionType
      • ChallengeParametersType
      • AuthenticationResultType
      • QueryLimitType
      • SearchPaginationTokenType
      • DeviceListType
      • PaginationKey
      • GroupListType
      • AuthEventsType
      • ChallengeResponsesType
      • SMSMfaSettingsType
      • SoftwareTokenMfaSettingsType
      • EventIdType
      • FeedbackValueType
      • DeviceRememberedStatusType
      • AdvancedSecurityModeType
      • AliasAttributeType
      • AliasAttributesListType
      • HexStringType
      • ArnType
      • AnalyticsConfigurationType
      • TokenModelType
      • SecretCodeType
      • AttributeDataType
      • AttributeType
      • AttributeMappingKeyType
      • AttributeMappingType
      • AttributeNameType
      • AttributeValueType
      • EventType
      • EventResponseType
      • EventRiskType
      • AttributesRequireVerificationBeforeUpdateType
      • ChallengeResponseListType
      • EventContextDataType
      • EventFeedbackType
      • AuthEventType
      • IntegerType
      • NewDeviceMetadataType
      • BlockedIPRangeListType
      • CSSType
      • AuthSessionValidityType
      • CSSVersionType
      • RedirectUrlType
      • CallbackURLsListType
      • ChallengeName
      • ChallengeResponse
      • ChallengeResponseType
      • ClientNameType
      • ClientPermissionType
      • ClientPermissionListType
      • ClientSecretType
      • CodeDeliveryDetailsType
      • CodeDeliveryDetailsListType
      • DeliveryMediumType
      • CompletionMessageType
      • CompromisedCredentialsEventActionType
      • CompromisedCredentialsActionsType
      • EventFiltersType
      • CompromisedCredentialsRiskConfigurationType
      • DeviceSecretVerifierConfigType
      • DeviceNameType
      • SecretHashType
      • ConfirmationCodeType
      • UserContextDataType
      • HttpHeaderList
      • DescriptionType
      • PrecedenceType
      • GroupType
      • ProviderNameTypeV1
      • IdentityProviderTypeType
      • ProviderDetailsType
      • IdpIdentifiersListType
      • IdentityProviderType
      • ResourceServerIdentifierType
      • ResourceServerNameType
      • ResourceServerScopeListType
      • ResourceServerType
      • UserImportJobNameType
      • UserImportJobType
      • GenerateSecret
      • RefreshTokenValidityType
      • IdTokenValidityType
      • TokenValidityUnitsType
      • ExplicitAuthFlowsListType
      • SupportedIdentityProvidersListType
      • LogoutURLsListType
      • OAuthFlowsType
      • ScopeListType
      • PreventUserExistenceErrorTypes
      • WrappedBooleanType
      • UserPoolClientType
      • DomainType
      • CustomDomainConfigType
      • UserPoolNameType
      • UserPoolPolicyType
      • LambdaConfigType
      • VerifiedAttributesListType
      • UsernameAttributesListType
      • SmsVerificationMessageType
      • EmailVerificationMessageType
      • DeletionProtectionType
      • EmailVerificationSubjectType
      • VerificationMessageTemplateType
      • UserPoolMfaType
      • DeviceConfigurationType
      • EmailConfigurationType
      • SmsConfigurationType
      • UserPoolTagsType
      • SchemaAttributesListType
      • UserPoolAddOnsType
      • UsernameConfigurationType
      • UserPoolType
      • CustomAttributeNameType
      • SchemaAttributeType
      • CustomEmailSenderLambdaVersionType
      • CustomEmailLambdaVersionConfigType
      • CustomSMSSenderLambdaVersionType
      • CustomSMSLambdaVersionConfigType
      • DefaultEmailOptionType
      • ProviderNameType
      • RiskConfigurationType
      • UserImportJobIdType
      • DomainDescriptionType
      • S3BucketType
      • DomainVersionType
      • DomainStatusType
      • EmailAddressType
      • EmailSendingAccountType
      • SESConfigurationSet
      • EmailNotificationBodyType
      • EmailNotificationSubjectType
      • EmailVerificationMessageByLinkType
      • EmailVerificationSubjectByLinkType
      • EventFilterType
      • RiskDecisionType
      • RiskLevelType
      • ExplicitAuthFlowsType
      • ListOfStringTypes
      • IdpIdentifierType
      • UICustomizationType
      • SmsMfaConfigType
      • SoftwareTokenMfaConfigType
      • HttpHeader
      • ImageFileType
      • ImageUrlType
      • ListProvidersLimitType
      • PaginationKeyType
      • ProvidersListType
      • ListResourceServersLimitType
      • ResourceServersListType
      • PoolQueryLimitType
      • UserImportJobsListType
      • QueryLimit
      • UserPoolClientListType
      • UserPoolListType
      • UsersListType
      • SearchedAttributeNamesListType
      • UserFilterType
      • LongType
      • MFAOptionType
      • NotifyEmailType
      • NumberAttributeConstraintsType
      • OAuthFlowType
      • PasswordPolicyMinLengthType
      • TemporaryPasswordValidityDaysType
      • PasswordPolicyType
      • PreSignedUrlType
      • PriorityType
      • ProviderDescription
      • RecoveryOptionType
      • RecoveryOptionNameType
      • ResourceServerScopeDescriptionType
      • ResourceServerScopeType
      • ResourceServerScopeNameType
      • RiskExceptionConfigurationType
      • SkippedIPRangeListType
      • StringAttributeConstraintsType
      • ScopeType
      • RegionCodeType
      • SoftwareTokenMFAUserCodeType
      • StatusType
      • TagKeysType
      • TagValueType
      • TimeUnitsType
      • UserPoolTagsListType
      • UserImportJobStatusType
      • UserPoolClientDescription
      • UserPoolDescriptionType
      • UsernameAttributeType
      • VerifiedAttributeType
      • VerifySoftwareTokenResponseType
  1. Schemas

SMSMfaSettingsType

The type used for enabling SMS MFA at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign in attempts, disable MFA for users and turn on Adaptive Authentication for the user pool.

{
    "Enabled": true,
    "PreferredMfa": true
}
Built with