aws-sdk-cognitoidentityprovider 1.148.0 → 1.149.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +101 -6
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +27 -0
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +100 -0
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- data/sig/client.rbs +15 -1
- data/sig/params.rbs +1 -1
- data/sig/types.rbs +16 -2
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 596a7ce8aa6cd1e63718f70d3e9760e382113bfc5a0a384c59ee90b4a54f400d
|
|
4
|
+
data.tar.gz: cc937a7321ff09b987ea70b47b0e9ba2e853141238ba481ea1298c6a434d0e89
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0a33ebb69d6441e6a61e0564f670e834792d19baf3305305a18d97d45c280d8138a35a3ab2ba04d836b395162a0697870ef323842f50a5db7dd3e18d548c73d7
|
|
7
|
+
data.tar.gz: 3b66ac29709c631addae7649fc7872460dbc0eacc7e02064a2763b34ae59cab2f7ae25bdf19a98972167da8df734f432dda4bcf8205e3b24d88d5f09787c4309
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.149.0 (2026-07-24)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Amazon Cognito user pools now support the AdminGetUserAuthFactors operation, which lets administrators retrieve the configured authentication factors (such as password, SMS, email, and TOTP) available for a specific user in a user pool.
|
|
8
|
+
|
|
4
9
|
1.148.0 (2026-07-17)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.149.0
|
|
@@ -1598,6 +1598,75 @@ module Aws::CognitoIdentityProvider
|
|
|
1598
1598
|
req.send_request(options)
|
|
1599
1599
|
end
|
|
1600
1600
|
|
|
1601
|
+
# Lists the authentication options for a user in a user pool. Returns
|
|
1602
|
+
# the following:
|
|
1603
|
+
#
|
|
1604
|
+
# 1. The user's multi-factor authentication (MFA) preferences.
|
|
1605
|
+
#
|
|
1606
|
+
# 2. The user's options for choice-based authentication with the
|
|
1607
|
+
# `USER_AUTH` flow.
|
|
1608
|
+
#
|
|
1609
|
+
# <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
|
|
1610
|
+
# in requests for this API operation. For this operation, you must use
|
|
1611
|
+
# IAM credentials to authorize requests, and you must grant yourself the
|
|
1612
|
+
# corresponding IAM permission in a policy.
|
|
1613
|
+
#
|
|
1614
|
+
# **Learn more**
|
|
1615
|
+
#
|
|
1616
|
+
# * [Signing Amazon Web Services API Requests][1]
|
|
1617
|
+
#
|
|
1618
|
+
# * [Using the Amazon Cognito user pools API and user pool endpoints][2]
|
|
1619
|
+
#
|
|
1620
|
+
# </note>
|
|
1621
|
+
#
|
|
1622
|
+
#
|
|
1623
|
+
#
|
|
1624
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
|
|
1625
|
+
# [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
|
|
1626
|
+
#
|
|
1627
|
+
# @option params [required, String] :user_pool_id
|
|
1628
|
+
# The ID of the user pool where you want to get information about the
|
|
1629
|
+
# user's authentication factors.
|
|
1630
|
+
#
|
|
1631
|
+
# @option params [required, String] :username
|
|
1632
|
+
# The name of the user that you want to query or modify. The value of
|
|
1633
|
+
# this parameter is typically your user's username, but it can be any
|
|
1634
|
+
# of their alias attributes. If `username` isn't an alias attribute in
|
|
1635
|
+
# your user pool, this value must be the `sub` of a local user or the
|
|
1636
|
+
# username of a user from a third-party IdP.
|
|
1637
|
+
#
|
|
1638
|
+
# @return [Types::AdminGetUserAuthFactorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1639
|
+
#
|
|
1640
|
+
# * {Types::AdminGetUserAuthFactorsResponse#username #username} => String
|
|
1641
|
+
# * {Types::AdminGetUserAuthFactorsResponse#preferred_mfa_setting #preferred_mfa_setting} => String
|
|
1642
|
+
# * {Types::AdminGetUserAuthFactorsResponse#user_mfa_setting_list #user_mfa_setting_list} => Array<String>
|
|
1643
|
+
# * {Types::AdminGetUserAuthFactorsResponse#configured_user_auth_factors #configured_user_auth_factors} => Array<String>
|
|
1644
|
+
#
|
|
1645
|
+
# @example Request syntax with placeholder values
|
|
1646
|
+
#
|
|
1647
|
+
# resp = client.admin_get_user_auth_factors({
|
|
1648
|
+
# user_pool_id: "UserPoolIdType", # required
|
|
1649
|
+
# username: "UsernameType", # required
|
|
1650
|
+
# })
|
|
1651
|
+
#
|
|
1652
|
+
# @example Response structure
|
|
1653
|
+
#
|
|
1654
|
+
# resp.username #=> String
|
|
1655
|
+
# resp.preferred_mfa_setting #=> String
|
|
1656
|
+
# resp.user_mfa_setting_list #=> Array
|
|
1657
|
+
# resp.user_mfa_setting_list[0] #=> String
|
|
1658
|
+
# resp.configured_user_auth_factors #=> Array
|
|
1659
|
+
# resp.configured_user_auth_factors[0] #=> String, one of "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN", "SOFTWARE_TOKEN"
|
|
1660
|
+
#
|
|
1661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUserAuthFactors AWS API Documentation
|
|
1662
|
+
#
|
|
1663
|
+
# @overload admin_get_user_auth_factors(params = {})
|
|
1664
|
+
# @param [Hash] params ({})
|
|
1665
|
+
def admin_get_user_auth_factors(params = {}, options = {})
|
|
1666
|
+
req = build_request(:admin_get_user_auth_factors, params)
|
|
1667
|
+
req.send_request(options)
|
|
1668
|
+
end
|
|
1669
|
+
|
|
1601
1670
|
# Starts sign-in for applications with a server-side component, for
|
|
1602
1671
|
# example a traditional web application. This operation specifies the
|
|
1603
1672
|
# authentication flow that you'd like to begin. The authentication flow
|
|
@@ -4887,6 +4956,23 @@ module Aws::CognitoIdentityProvider
|
|
|
4887
4956
|
# prompts in API responses and in managed login for users who have
|
|
4888
4957
|
# chosen and configured a preferred MFA factor.
|
|
4889
4958
|
#
|
|
4959
|
+
# The `CreateUserPool` operation supports only SMS MFA configuration. If
|
|
4960
|
+
# you set `MfaConfiguration` to either of these values, include an
|
|
4961
|
+
# `SmsConfiguration` in the same request:
|
|
4962
|
+
#
|
|
4963
|
+
# * `ON` – Requires MFA for all users
|
|
4964
|
+
#
|
|
4965
|
+
# * `OPTIONAL` – Makes MFA optional for each user
|
|
4966
|
+
#
|
|
4967
|
+
# If you omit `SmsConfiguration`, the operation returns an
|
|
4968
|
+
# `InvalidParameterException`. To configure TOTP or email MFA, use the
|
|
4969
|
+
# [SetUserPoolMfaConfig][1] operation. You can also use
|
|
4970
|
+
# `SetUserPoolMfaConfig` to add MFA factors later.
|
|
4971
|
+
#
|
|
4972
|
+
#
|
|
4973
|
+
#
|
|
4974
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html
|
|
4975
|
+
#
|
|
4890
4976
|
# @option params [Types::UserAttributeUpdateSettingsType] :user_attribute_update_settings
|
|
4891
4977
|
# The settings for updates to user attributes. These settings include
|
|
4892
4978
|
# the property `AttributesRequireVerificationBeforeUpdate`, a user-pool
|
|
@@ -5504,7 +5590,7 @@ module Aws::CognitoIdentityProvider
|
|
|
5504
5590
|
# temporary_password_validity_days: 1,
|
|
5505
5591
|
# },
|
|
5506
5592
|
# sign_in_policy: {
|
|
5507
|
-
# allowed_first_auth_factors: ["PASSWORD"], # accepts PASSWORD, EMAIL_OTP, SMS_OTP, WEB_AUTHN
|
|
5593
|
+
# allowed_first_auth_factors: ["PASSWORD"], # accepts PASSWORD, EMAIL_OTP, SMS_OTP, WEB_AUTHN, SOFTWARE_TOKEN
|
|
5508
5594
|
# },
|
|
5509
5595
|
# },
|
|
5510
5596
|
# deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
|
|
@@ -5649,7 +5735,7 @@ module Aws::CognitoIdentityProvider
|
|
|
5649
5735
|
# resp.user_pool.policies.password_policy.password_history_size #=> Integer
|
|
5650
5736
|
# resp.user_pool.policies.password_policy.temporary_password_validity_days #=> Integer
|
|
5651
5737
|
# resp.user_pool.policies.sign_in_policy.allowed_first_auth_factors #=> Array
|
|
5652
|
-
# resp.user_pool.policies.sign_in_policy.allowed_first_auth_factors[0] #=> String, one of "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN"
|
|
5738
|
+
# resp.user_pool.policies.sign_in_policy.allowed_first_auth_factors[0] #=> String, one of "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN", "SOFTWARE_TOKEN"
|
|
5653
5739
|
# resp.user_pool.deletion_protection #=> String, one of "ACTIVE", "INACTIVE"
|
|
5654
5740
|
# resp.user_pool.lambda_config.pre_sign_up #=> String
|
|
5655
5741
|
# resp.user_pool.lambda_config.custom_message #=> String
|
|
@@ -6424,9 +6510,18 @@ module Aws::CognitoIdentityProvider
|
|
|
6424
6510
|
# Managed login requires that your user pool be configured for any
|
|
6425
6511
|
# [feature plan][1] other than `Lite`.
|
|
6426
6512
|
#
|
|
6513
|
+
# A `ManagedLoginVersion` value of `2` does not activate managed login
|
|
6514
|
+
# pages for your app client. When you create an app client
|
|
6515
|
+
# programmatically, your app client has no branding style. To use
|
|
6516
|
+
# managed login, create a branding style using the
|
|
6517
|
+
# [CreateManagedLoginBranding][2] operation. When you use the console,
|
|
6518
|
+
# Amazon Cognito assigns a default branding style automatically. When
|
|
6519
|
+
# you use the API or an SDK, you must create a branding style yourself.
|
|
6520
|
+
#
|
|
6427
6521
|
#
|
|
6428
6522
|
#
|
|
6429
6523
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html
|
|
6524
|
+
# [2]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateManagedLoginBranding.html
|
|
6430
6525
|
#
|
|
6431
6526
|
# @option params [Types::CustomDomainConfigType] :custom_domain_config
|
|
6432
6527
|
# The configuration for a custom domain. Configures your domain with an
|
|
@@ -7585,7 +7680,7 @@ module Aws::CognitoIdentityProvider
|
|
|
7585
7680
|
# resp.user_pool.policies.password_policy.password_history_size #=> Integer
|
|
7586
7681
|
# resp.user_pool.policies.password_policy.temporary_password_validity_days #=> Integer
|
|
7587
7682
|
# resp.user_pool.policies.sign_in_policy.allowed_first_auth_factors #=> Array
|
|
7588
|
-
# resp.user_pool.policies.sign_in_policy.allowed_first_auth_factors[0] #=> String, one of "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN"
|
|
7683
|
+
# resp.user_pool.policies.sign_in_policy.allowed_first_auth_factors[0] #=> String, one of "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN", "SOFTWARE_TOKEN"
|
|
7589
7684
|
# resp.user_pool.deletion_protection #=> String, one of "ACTIVE", "INACTIVE"
|
|
7590
7685
|
# resp.user_pool.lambda_config.pre_sign_up #=> String
|
|
7591
7686
|
# resp.user_pool.lambda_config.custom_message #=> String
|
|
@@ -8859,7 +8954,7 @@ module Aws::CognitoIdentityProvider
|
|
|
8859
8954
|
# resp.user_mfa_setting_list #=> Array
|
|
8860
8955
|
# resp.user_mfa_setting_list[0] #=> String
|
|
8861
8956
|
# resp.configured_user_auth_factors #=> Array
|
|
8862
|
-
# resp.configured_user_auth_factors[0] #=> String, one of "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN"
|
|
8957
|
+
# resp.configured_user_auth_factors[0] #=> String, one of "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN", "SOFTWARE_TOKEN"
|
|
8863
8958
|
#
|
|
8864
8959
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserAuthFactors AWS API Documentation
|
|
8865
8960
|
#
|
|
@@ -13389,7 +13484,7 @@ module Aws::CognitoIdentityProvider
|
|
|
13389
13484
|
# temporary_password_validity_days: 1,
|
|
13390
13485
|
# },
|
|
13391
13486
|
# sign_in_policy: {
|
|
13392
|
-
# allowed_first_auth_factors: ["PASSWORD"], # accepts PASSWORD, EMAIL_OTP, SMS_OTP, WEB_AUTHN
|
|
13487
|
+
# allowed_first_auth_factors: ["PASSWORD"], # accepts PASSWORD, EMAIL_OTP, SMS_OTP, WEB_AUTHN, SOFTWARE_TOKEN
|
|
13393
13488
|
# },
|
|
13394
13489
|
# },
|
|
13395
13490
|
# deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
|
|
@@ -14323,7 +14418,7 @@ module Aws::CognitoIdentityProvider
|
|
|
14323
14418
|
tracer: tracer
|
|
14324
14419
|
)
|
|
14325
14420
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
|
14326
|
-
context[:gem_version] = '1.
|
|
14421
|
+
context[:gem_version] = '1.149.0'
|
|
14327
14422
|
Seahorse::Client::Request.new(handlers, context)
|
|
14328
14423
|
end
|
|
14329
14424
|
|
|
@@ -46,6 +46,8 @@ module Aws::CognitoIdentityProvider
|
|
|
46
46
|
AdminForgetDeviceRequest = Shapes::StructureShape.new(name: 'AdminForgetDeviceRequest')
|
|
47
47
|
AdminGetDeviceRequest = Shapes::StructureShape.new(name: 'AdminGetDeviceRequest')
|
|
48
48
|
AdminGetDeviceResponse = Shapes::StructureShape.new(name: 'AdminGetDeviceResponse')
|
|
49
|
+
AdminGetUserAuthFactorsRequest = Shapes::StructureShape.new(name: 'AdminGetUserAuthFactorsRequest')
|
|
50
|
+
AdminGetUserAuthFactorsResponse = Shapes::StructureShape.new(name: 'AdminGetUserAuthFactorsResponse')
|
|
49
51
|
AdminGetUserRequest = Shapes::StructureShape.new(name: 'AdminGetUserRequest')
|
|
50
52
|
AdminGetUserResponse = Shapes::StructureShape.new(name: 'AdminGetUserResponse')
|
|
51
53
|
AdminInitiateAuthRequest = Shapes::StructureShape.new(name: 'AdminInitiateAuthRequest')
|
|
@@ -748,6 +750,16 @@ module Aws::CognitoIdentityProvider
|
|
|
748
750
|
AdminGetDeviceResponse.add_member(:device, Shapes::ShapeRef.new(shape: DeviceType, required: true, location_name: "Device"))
|
|
749
751
|
AdminGetDeviceResponse.struct_class = Types::AdminGetDeviceResponse
|
|
750
752
|
|
|
753
|
+
AdminGetUserAuthFactorsRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
|
|
754
|
+
AdminGetUserAuthFactorsRequest.add_member(:username, Shapes::ShapeRef.new(shape: UsernameType, required: true, location_name: "Username"))
|
|
755
|
+
AdminGetUserAuthFactorsRequest.struct_class = Types::AdminGetUserAuthFactorsRequest
|
|
756
|
+
|
|
757
|
+
AdminGetUserAuthFactorsResponse.add_member(:username, Shapes::ShapeRef.new(shape: UsernameType, required: true, location_name: "Username"))
|
|
758
|
+
AdminGetUserAuthFactorsResponse.add_member(:preferred_mfa_setting, Shapes::ShapeRef.new(shape: StringType, location_name: "PreferredMfaSetting"))
|
|
759
|
+
AdminGetUserAuthFactorsResponse.add_member(:user_mfa_setting_list, Shapes::ShapeRef.new(shape: UserMFASettingListType, location_name: "UserMFASettingList"))
|
|
760
|
+
AdminGetUserAuthFactorsResponse.add_member(:configured_user_auth_factors, Shapes::ShapeRef.new(shape: ConfiguredUserAuthFactorsListType, location_name: "ConfiguredUserAuthFactors"))
|
|
761
|
+
AdminGetUserAuthFactorsResponse.struct_class = Types::AdminGetUserAuthFactorsResponse
|
|
762
|
+
|
|
751
763
|
AdminGetUserRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
|
|
752
764
|
AdminGetUserRequest.add_member(:username, Shapes::ShapeRef.new(shape: UsernameType, required: true, location_name: "Username"))
|
|
753
765
|
AdminGetUserRequest.struct_class = Types::AdminGetUserRequest
|
|
@@ -2884,6 +2896,21 @@ module Aws::CognitoIdentityProvider
|
|
|
2884
2896
|
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
|
2885
2897
|
end)
|
|
2886
2898
|
|
|
2899
|
+
api.add_operation(:admin_get_user_auth_factors, Seahorse::Model::Operation.new.tap do |o|
|
|
2900
|
+
o.name = "AdminGetUserAuthFactors"
|
|
2901
|
+
o.http_method = "POST"
|
|
2902
|
+
o.http_request_uri = "/"
|
|
2903
|
+
o.input = Shapes::ShapeRef.new(shape: AdminGetUserAuthFactorsRequest)
|
|
2904
|
+
o.output = Shapes::ShapeRef.new(shape: AdminGetUserAuthFactorsResponse)
|
|
2905
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
2906
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
|
2907
|
+
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
|
2908
|
+
o.errors << Shapes::ShapeRef.new(shape: OperationNotEnabledException)
|
|
2909
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
2910
|
+
o.errors << Shapes::ShapeRef.new(shape: UserNotFoundException)
|
|
2911
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
|
2912
|
+
end)
|
|
2913
|
+
|
|
2887
2914
|
api.add_operation(:admin_initiate_auth, Seahorse::Model::Operation.new.tap do |o|
|
|
2888
2915
|
o.name = "AdminInitiateAuth"
|
|
2889
2916
|
o.http_method = "POST"
|
|
@@ -809,6 +809,67 @@ module Aws::CognitoIdentityProvider
|
|
|
809
809
|
include Aws::Structure
|
|
810
810
|
end
|
|
811
811
|
|
|
812
|
+
# @!attribute [rw] user_pool_id
|
|
813
|
+
# The ID of the user pool where you want to get information about the
|
|
814
|
+
# user's authentication factors.
|
|
815
|
+
# @return [String]
|
|
816
|
+
#
|
|
817
|
+
# @!attribute [rw] username
|
|
818
|
+
# The name of the user that you want to query or modify. The value of
|
|
819
|
+
# this parameter is typically your user's username, but it can be any
|
|
820
|
+
# of their alias attributes. If `username` isn't an alias attribute
|
|
821
|
+
# in your user pool, this value must be the `sub` of a local user or
|
|
822
|
+
# the username of a user from a third-party IdP.
|
|
823
|
+
# @return [String]
|
|
824
|
+
#
|
|
825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUserAuthFactorsRequest AWS API Documentation
|
|
826
|
+
#
|
|
827
|
+
class AdminGetUserAuthFactorsRequest < Struct.new(
|
|
828
|
+
:user_pool_id,
|
|
829
|
+
:username)
|
|
830
|
+
SENSITIVE = [:username]
|
|
831
|
+
include Aws::Structure
|
|
832
|
+
end
|
|
833
|
+
|
|
834
|
+
# @!attribute [rw] username
|
|
835
|
+
# The name of the user who is eligible for the authentication factors
|
|
836
|
+
# in the response.
|
|
837
|
+
# @return [String]
|
|
838
|
+
#
|
|
839
|
+
# @!attribute [rw] preferred_mfa_setting
|
|
840
|
+
# The challenge method that Amazon Cognito returns to the user in
|
|
841
|
+
# response to sign-in requests. Users can prefer SMS message, email
|
|
842
|
+
# message, or TOTP MFA.
|
|
843
|
+
# @return [String]
|
|
844
|
+
#
|
|
845
|
+
# @!attribute [rw] user_mfa_setting_list
|
|
846
|
+
# The MFA options that are activated for the user. The possible values
|
|
847
|
+
# in this list are `SMS_MFA`, `EMAIL_OTP`, and `SOFTWARE_TOKEN_MFA`.
|
|
848
|
+
# @return [Array<String>]
|
|
849
|
+
#
|
|
850
|
+
# @!attribute [rw] configured_user_auth_factors
|
|
851
|
+
# The authentication types that are available to the user with
|
|
852
|
+
# `USER_AUTH` sign-in, for example `["PASSWORD", "WEB_AUTHN"]`.
|
|
853
|
+
#
|
|
854
|
+
# `PASSWORD` can only be used as a first authentication factor.
|
|
855
|
+
# `SOFTWARE_TOKEN` can only be used as an MFA factor. `EMAIL_OTP`,
|
|
856
|
+
# `SMS_OTP`, and `WEB_AUTHN` can be used as either a first
|
|
857
|
+
# authentication factor or an MFA factor. `WEB_AUTHN` is available as
|
|
858
|
+
# an MFA factor only when passkey MFA is enabled at the user pool
|
|
859
|
+
# level.
|
|
860
|
+
# @return [Array<String>]
|
|
861
|
+
#
|
|
862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUserAuthFactorsResponse AWS API Documentation
|
|
863
|
+
#
|
|
864
|
+
class AdminGetUserAuthFactorsResponse < Struct.new(
|
|
865
|
+
:username,
|
|
866
|
+
:preferred_mfa_setting,
|
|
867
|
+
:user_mfa_setting_list,
|
|
868
|
+
:configured_user_auth_factors)
|
|
869
|
+
SENSITIVE = [:username]
|
|
870
|
+
include Aws::Structure
|
|
871
|
+
end
|
|
872
|
+
|
|
812
873
|
# Represents the request to get the specified user as an administrator.
|
|
813
874
|
#
|
|
814
875
|
# @!attribute [rw] user_pool_id
|
|
@@ -4543,9 +4604,19 @@ module Aws::CognitoIdentityProvider
|
|
|
4543
4604
|
# Managed login requires that your user pool be configured for any
|
|
4544
4605
|
# [feature plan][1] other than `Lite`.
|
|
4545
4606
|
#
|
|
4607
|
+
# A `ManagedLoginVersion` value of `2` does not activate managed login
|
|
4608
|
+
# pages for your app client. When you create an app client
|
|
4609
|
+
# programmatically, your app client has no branding style. To use
|
|
4610
|
+
# managed login, create a branding style using the
|
|
4611
|
+
# [CreateManagedLoginBranding][2] operation. When you use the console,
|
|
4612
|
+
# Amazon Cognito assigns a default branding style automatically. When
|
|
4613
|
+
# you use the API or an SDK, you must create a branding style
|
|
4614
|
+
# yourself.
|
|
4615
|
+
#
|
|
4546
4616
|
#
|
|
4547
4617
|
#
|
|
4548
4618
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html
|
|
4619
|
+
# [2]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateManagedLoginBranding.html
|
|
4549
4620
|
# @return [Integer]
|
|
4550
4621
|
#
|
|
4551
4622
|
# @!attribute [rw] custom_domain_config
|
|
@@ -4761,6 +4832,23 @@ module Aws::CognitoIdentityProvider
|
|
|
4761
4832
|
# automatically prompt users to set up MFA. Amazon Cognito generates
|
|
4762
4833
|
# MFA prompts in API responses and in managed login for users who have
|
|
4763
4834
|
# chosen and configured a preferred MFA factor.
|
|
4835
|
+
#
|
|
4836
|
+
# The `CreateUserPool` operation supports only SMS MFA configuration.
|
|
4837
|
+
# If you set `MfaConfiguration` to either of these values, include an
|
|
4838
|
+
# `SmsConfiguration` in the same request:
|
|
4839
|
+
#
|
|
4840
|
+
# * `ON` – Requires MFA for all users
|
|
4841
|
+
#
|
|
4842
|
+
# * `OPTIONAL` – Makes MFA optional for each user
|
|
4843
|
+
#
|
|
4844
|
+
# If you omit `SmsConfiguration`, the operation returns an
|
|
4845
|
+
# `InvalidParameterException`. To configure TOTP or email MFA, use the
|
|
4846
|
+
# [SetUserPoolMfaConfig][1] operation. You can also use
|
|
4847
|
+
# `SetUserPoolMfaConfig` to add MFA factors later.
|
|
4848
|
+
#
|
|
4849
|
+
#
|
|
4850
|
+
#
|
|
4851
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html
|
|
4764
4852
|
# @return [String]
|
|
4765
4853
|
#
|
|
4766
4854
|
# @!attribute [rw] user_attribute_update_settings
|
|
@@ -6975,6 +7063,13 @@ module Aws::CognitoIdentityProvider
|
|
|
6975
7063
|
# @!attribute [rw] configured_user_auth_factors
|
|
6976
7064
|
# The authentication types that are available to the user with
|
|
6977
7065
|
# `USER_AUTH` sign-in, for example `["PASSWORD", "WEB_AUTHN"]`.
|
|
7066
|
+
#
|
|
7067
|
+
# `PASSWORD` can only be used as a first authentication factor.
|
|
7068
|
+
# `SOFTWARE_TOKEN` can only be used as an MFA factor. `EMAIL_OTP`,
|
|
7069
|
+
# `SMS_OTP`, and `WEB_AUTHN` can be used as either a first
|
|
7070
|
+
# authentication factor or an MFA factor. `WEB_AUTHN` is available as
|
|
7071
|
+
# an MFA factor only when passkey MFA is enabled at the user pool
|
|
7072
|
+
# level.
|
|
6978
7073
|
# @return [Array<String>]
|
|
6979
7074
|
#
|
|
6980
7075
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserAuthFactorsResponse AWS API Documentation
|
|
@@ -11087,6 +11182,11 @@ module Aws::CognitoIdentityProvider
|
|
|
11087
11182
|
# You can permit users to start authentication with a standard
|
|
11088
11183
|
# username and password, or with other one-time password and hardware
|
|
11089
11184
|
# factors.
|
|
11185
|
+
#
|
|
11186
|
+
# <note markdown="1"> `SOFTWARE_TOKEN` is not currently supported as a first auth factor.
|
|
11187
|
+
# Do not include this value in `AllowedFirstAuthFactors`.
|
|
11188
|
+
#
|
|
11189
|
+
# </note>
|
|
11090
11190
|
# @return [Array<String>]
|
|
11091
11191
|
#
|
|
11092
11192
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SignInPolicyType AWS API Documentation
|
data/sig/client.rbs
CHANGED
|
@@ -241,6 +241,20 @@ module Aws
|
|
|
241
241
|
) -> _AdminGetUserResponseSuccess
|
|
242
242
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminGetUserResponseSuccess
|
|
243
243
|
|
|
244
|
+
interface _AdminGetUserAuthFactorsResponseSuccess
|
|
245
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AdminGetUserAuthFactorsResponse]
|
|
246
|
+
def username: () -> ::String
|
|
247
|
+
def preferred_mfa_setting: () -> ::String
|
|
248
|
+
def user_mfa_setting_list: () -> ::Array[::String]
|
|
249
|
+
def configured_user_auth_factors: () -> ::Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN" | "SOFTWARE_TOKEN")]
|
|
250
|
+
end
|
|
251
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#admin_get_user_auth_factors-instance_method
|
|
252
|
+
def admin_get_user_auth_factors: (
|
|
253
|
+
user_pool_id: ::String,
|
|
254
|
+
username: ::String
|
|
255
|
+
) -> _AdminGetUserAuthFactorsResponseSuccess
|
|
256
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AdminGetUserAuthFactorsResponseSuccess
|
|
257
|
+
|
|
244
258
|
interface _AdminInitiateAuthResponseSuccess
|
|
245
259
|
include ::Seahorse::Client::_ResponseSuccess[Types::AdminInitiateAuthResponse]
|
|
246
260
|
def challenge_name: () -> ("SMS_MFA" | "EMAIL_OTP" | "SOFTWARE_TOKEN_MFA" | "SELECT_MFA_TYPE" | "MFA_SETUP" | "PASSWORD_VERIFIER" | "CUSTOM_CHALLENGE" | "SELECT_CHALLENGE" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "NEW_PASSWORD_REQUIRED" | "SMS_OTP" | "PASSWORD" | "WEB_AUTHN" | "PASSWORD_SRP")
|
|
@@ -1187,7 +1201,7 @@ module Aws
|
|
|
1187
1201
|
def username: () -> ::String
|
|
1188
1202
|
def preferred_mfa_setting: () -> ::String
|
|
1189
1203
|
def user_mfa_setting_list: () -> ::Array[::String]
|
|
1190
|
-
def configured_user_auth_factors: () -> ::Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN")]
|
|
1204
|
+
def configured_user_auth_factors: () -> ::Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN" | "SOFTWARE_TOKEN")]
|
|
1191
1205
|
end
|
|
1192
1206
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html#get_user_auth_factors-instance_method
|
|
1193
1207
|
def get_user_auth_factors: (
|
data/sig/params.rbs
CHANGED
|
@@ -50,7 +50,7 @@ module Aws
|
|
|
50
50
|
type user_pool_policy_type = {
|
|
51
51
|
password_policy: Params::password_policy_type?,
|
|
52
52
|
sign_in_policy: {
|
|
53
|
-
allowed_first_auth_factors: Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN")]?
|
|
53
|
+
allowed_first_auth_factors: Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN" | "SOFTWARE_TOKEN")]?
|
|
54
54
|
}?
|
|
55
55
|
}
|
|
56
56
|
|
data/sig/types.rbs
CHANGED
|
@@ -162,6 +162,20 @@ module Aws::CognitoIdentityProvider
|
|
|
162
162
|
SENSITIVE: []
|
|
163
163
|
end
|
|
164
164
|
|
|
165
|
+
class AdminGetUserAuthFactorsRequest
|
|
166
|
+
attr_accessor user_pool_id: ::String
|
|
167
|
+
attr_accessor username: ::String
|
|
168
|
+
SENSITIVE: [:username]
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
class AdminGetUserAuthFactorsResponse
|
|
172
|
+
attr_accessor username: ::String
|
|
173
|
+
attr_accessor preferred_mfa_setting: ::String
|
|
174
|
+
attr_accessor user_mfa_setting_list: ::Array[::String]
|
|
175
|
+
attr_accessor configured_user_auth_factors: ::Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN" | "SOFTWARE_TOKEN")]
|
|
176
|
+
SENSITIVE: [:username]
|
|
177
|
+
end
|
|
178
|
+
|
|
165
179
|
class AdminGetUserRequest
|
|
166
180
|
attr_accessor user_pool_id: ::String
|
|
167
181
|
attr_accessor username: ::String
|
|
@@ -1239,7 +1253,7 @@ module Aws::CognitoIdentityProvider
|
|
|
1239
1253
|
attr_accessor username: ::String
|
|
1240
1254
|
attr_accessor preferred_mfa_setting: ::String
|
|
1241
1255
|
attr_accessor user_mfa_setting_list: ::Array[::String]
|
|
1242
|
-
attr_accessor configured_user_auth_factors: ::Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN")]
|
|
1256
|
+
attr_accessor configured_user_auth_factors: ::Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN" | "SOFTWARE_TOKEN")]
|
|
1243
1257
|
SENSITIVE: [:username]
|
|
1244
1258
|
end
|
|
1245
1259
|
|
|
@@ -1965,7 +1979,7 @@ module Aws::CognitoIdentityProvider
|
|
|
1965
1979
|
end
|
|
1966
1980
|
|
|
1967
1981
|
class SignInPolicyType
|
|
1968
|
-
attr_accessor allowed_first_auth_factors: ::Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN")]
|
|
1982
|
+
attr_accessor allowed_first_auth_factors: ::Array[("PASSWORD" | "EMAIL_OTP" | "SMS_OTP" | "WEB_AUTHN" | "SOFTWARE_TOKEN")]
|
|
1969
1983
|
SENSITIVE: []
|
|
1970
1984
|
end
|
|
1971
1985
|
|