aws-sdk-cognitoidentityprovider 1.127.0 → 1.128.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 +590 -103
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +160 -0
- data/lib/aws-sdk-cognitoidentityprovider/errors.rb +16 -0
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +681 -193
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- data/sig/client.rbs +61 -0
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +87 -0
- metadata +1 -1
@@ -926,30 +926,44 @@ module Aws::CognitoIdentityProvider
|
|
926
926
|
#
|
927
927
|
# @!attribute [rw] auth_parameters
|
928
928
|
# The authentication parameters. These are inputs corresponding to the
|
929
|
-
# `AuthFlow` that you're invoking.
|
930
|
-
#
|
929
|
+
# `AuthFlow` that you're invoking.
|
930
|
+
#
|
931
|
+
# The following are some authentication flows and their parameters.
|
932
|
+
# Add a `SECRET_HASH` parameter if your app client has a client
|
933
|
+
# secret. Add `DEVICE_KEY` if you want to bypass multi-factor
|
934
|
+
# authentication with a remembered device.
|
935
|
+
#
|
936
|
+
# USER\_AUTH
|
937
|
+
# : * `USERNAME` (required)
|
938
|
+
#
|
939
|
+
# * `PREFERRED_CHALLENGE`. If you don't provide a value for
|
940
|
+
# `PREFERRED_CHALLENGE`, Amazon Cognito responds with the
|
941
|
+
# `AvailableChallenges` parameter that specifies the available
|
942
|
+
# sign-in methods.
|
931
943
|
#
|
932
|
-
#
|
933
|
-
#
|
934
|
-
# Cognito responds with the `AvailableChallenges` parameter that
|
935
|
-
# specifies the available sign-in methods.
|
944
|
+
# USER\_SRP\_AUTH
|
945
|
+
# : * `USERNAME` (required)
|
936
946
|
#
|
937
|
-
#
|
938
|
-
#
|
939
|
-
#
|
947
|
+
# * `SRP_A` (required)
|
948
|
+
#
|
949
|
+
# ADMIN\_USER\_PASSWORD\_AUTH
|
950
|
+
# : * `USERNAME` (required)
|
940
951
|
#
|
941
|
-
#
|
942
|
-
# (required), `SECRET_HASH` (required if the app client is
|
943
|
-
# configured with a client secret), `DEVICE_KEY`.
|
952
|
+
# * `PASSWORD` (required)
|
944
953
|
#
|
945
|
-
#
|
946
|
-
#
|
947
|
-
# configured with a client secret), `DEVICE_KEY`.
|
954
|
+
# REFRESH\_TOKEN\_AUTH/REFRESH\_TOKEN
|
955
|
+
# : * `REFRESH_TOKEN`(required)
|
948
956
|
#
|
949
|
-
#
|
950
|
-
#
|
951
|
-
#
|
952
|
-
#
|
957
|
+
# ^
|
958
|
+
#
|
959
|
+
# CUSTOM\_AUTH
|
960
|
+
# : * `USERNAME` (required)
|
961
|
+
#
|
962
|
+
# * `ChallengeName: SRP_A` (when preceding custom authentication
|
963
|
+
# with SRP authentication)
|
964
|
+
#
|
965
|
+
# * `SRP_A: (An SRP_A value)` (when preceding custom authentication
|
966
|
+
# with SRP authentication)
|
953
967
|
#
|
954
968
|
# For more information about `SECRET_HASH`, see [Computing secret hash
|
955
969
|
# values][1]. For information about `DEVICE_KEY`, see [Working with
|
@@ -1080,43 +1094,46 @@ module Aws::CognitoIdentityProvider
|
|
1080
1094
|
# Possible challenges include the following:
|
1081
1095
|
#
|
1082
1096
|
# <note markdown="1"> All of the following challenges require `USERNAME` and, when the app
|
1083
|
-
# client has a client secret, `SECRET_HASH` in the parameters.
|
1097
|
+
# client has a client secret, `SECRET_HASH` in the parameters. Include
|
1098
|
+
# a `DEVICE_KEY` for device authentication.
|
1084
1099
|
#
|
1085
1100
|
# </note>
|
1086
1101
|
#
|
1087
1102
|
# * `WEB_AUTHN`: Respond to the challenge with the results of a
|
1088
1103
|
# successful authentication with a WebAuthn authenticator, or
|
1089
|
-
# passkey
|
1090
|
-
# devices and security keys.
|
1104
|
+
# passkey, as `CREDENTIAL`. Examples of WebAuthn authenticators
|
1105
|
+
# include biometric devices and security keys.
|
1106
|
+
#
|
1107
|
+
# * `PASSWORD`: Respond with the user's password as `PASSWORD`.
|
1091
1108
|
#
|
1092
|
-
# * `
|
1093
|
-
# `USERNAME` (required), `PASSWORD` (required), `SECRET_HASH`
|
1094
|
-
# (required if the app client is configured with a client secret),
|
1095
|
-
# `DEVICE_KEY`.
|
1109
|
+
# * `PASSWORD_SRP`: Respond with the initial SRP secret as `SRP_A`.
|
1096
1110
|
#
|
1097
|
-
# * `
|
1098
|
-
# `
|
1099
|
-
#
|
1100
|
-
# `
|
1111
|
+
# * `SELECT_CHALLENGE`: Respond with a challenge selection as
|
1112
|
+
# `ANSWER`. It must be one of the challenge types in the
|
1113
|
+
# `AvailableChallenges` response parameter. Add the parameters of
|
1114
|
+
# the selected challenge, for example `USERNAME` and `SMS_OTP`.
|
1101
1115
|
#
|
1102
|
-
# * `
|
1103
|
-
# an
|
1104
|
-
# `AvailableChallenges` response parameter.
|
1116
|
+
# * `SMS_MFA`: Respond with the code that your user pool delivered in
|
1117
|
+
# an SMS message, as `SMS_MFA_CODE`
|
1105
1118
|
#
|
1106
|
-
# * `
|
1107
|
-
#
|
1119
|
+
# * `EMAIL_MFA`: Respond with the code that your user pool delivered
|
1120
|
+
# in an email message, as `EMAIL_MFA_CODE`
|
1108
1121
|
#
|
1109
|
-
# * `EMAIL_OTP`: Respond with
|
1110
|
-
#
|
1122
|
+
# * `EMAIL_OTP`: Respond with the code that your user pool delivered
|
1123
|
+
# in an email message, as `EMAIL_OTP_CODE` .
|
1111
1124
|
#
|
1112
|
-
# * `
|
1113
|
-
#
|
1114
|
-
#
|
1125
|
+
# * `SMS_OTP`: Respond with the code that your user pool delivered in
|
1126
|
+
# an SMS message, as `SMS_OTP_CODE`.
|
1127
|
+
#
|
1128
|
+
# * `PASSWORD_VERIFIER`: Respond with the second stage of SRP secrets
|
1129
|
+
# as `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and
|
1130
|
+
# `TIMESTAMP`.
|
1115
1131
|
#
|
1116
1132
|
# * `CUSTOM_CHALLENGE`: This is returned if your custom authentication
|
1117
1133
|
# flow determines that the user should pass another challenge before
|
1118
1134
|
# tokens are issued. The parameters of the challenge are determined
|
1119
|
-
# by your Lambda function
|
1135
|
+
# by your Lambda function and issued in the `ChallengeParameters` of
|
1136
|
+
# a challenge response.
|
1120
1137
|
#
|
1121
1138
|
# * `DEVICE_SRP_AUTH`: Respond with the initial parameters of device
|
1122
1139
|
# SRP authentication. For more information, see [Signing in with a
|
@@ -1602,43 +1619,46 @@ module Aws::CognitoIdentityProvider
|
|
1602
1619
|
# Possible challenges include the following:
|
1603
1620
|
#
|
1604
1621
|
# <note markdown="1"> All of the following challenges require `USERNAME` and, when the app
|
1605
|
-
# client has a client secret, `SECRET_HASH` in the parameters.
|
1622
|
+
# client has a client secret, `SECRET_HASH` in the parameters. Include
|
1623
|
+
# a `DEVICE_KEY` for device authentication.
|
1606
1624
|
#
|
1607
1625
|
# </note>
|
1608
1626
|
#
|
1609
1627
|
# * `WEB_AUTHN`: Respond to the challenge with the results of a
|
1610
1628
|
# successful authentication with a WebAuthn authenticator, or
|
1611
|
-
# passkey
|
1612
|
-
# devices and security keys.
|
1629
|
+
# passkey, as `CREDENTIAL`. Examples of WebAuthn authenticators
|
1630
|
+
# include biometric devices and security keys.
|
1631
|
+
#
|
1632
|
+
# * `PASSWORD`: Respond with the user's password as `PASSWORD`.
|
1613
1633
|
#
|
1614
|
-
# * `
|
1615
|
-
# `USERNAME` (required), `PASSWORD` (required), `SECRET_HASH`
|
1616
|
-
# (required if the app client is configured with a client secret),
|
1617
|
-
# `DEVICE_KEY`.
|
1634
|
+
# * `PASSWORD_SRP`: Respond with the initial SRP secret as `SRP_A`.
|
1618
1635
|
#
|
1619
|
-
# * `
|
1620
|
-
# `
|
1621
|
-
#
|
1622
|
-
# `
|
1636
|
+
# * `SELECT_CHALLENGE`: Respond with a challenge selection as
|
1637
|
+
# `ANSWER`. It must be one of the challenge types in the
|
1638
|
+
# `AvailableChallenges` response parameter. Add the parameters of
|
1639
|
+
# the selected challenge, for example `USERNAME` and `SMS_OTP`.
|
1623
1640
|
#
|
1624
|
-
# * `
|
1625
|
-
# an
|
1626
|
-
# `AvailableChallenges` response parameter.
|
1641
|
+
# * `SMS_MFA`: Respond with the code that your user pool delivered in
|
1642
|
+
# an SMS message, as `SMS_MFA_CODE`
|
1627
1643
|
#
|
1628
|
-
# * `
|
1629
|
-
#
|
1644
|
+
# * `EMAIL_MFA`: Respond with the code that your user pool delivered
|
1645
|
+
# in an email message, as `EMAIL_MFA_CODE`
|
1630
1646
|
#
|
1631
|
-
# * `EMAIL_OTP`: Respond with
|
1632
|
-
#
|
1647
|
+
# * `EMAIL_OTP`: Respond with the code that your user pool delivered
|
1648
|
+
# in an email message, as `EMAIL_OTP_CODE` .
|
1633
1649
|
#
|
1634
|
-
# * `
|
1635
|
-
#
|
1636
|
-
#
|
1650
|
+
# * `SMS_OTP`: Respond with the code that your user pool delivered in
|
1651
|
+
# an SMS message, as `SMS_OTP_CODE`.
|
1652
|
+
#
|
1653
|
+
# * `PASSWORD_VERIFIER`: Respond with the second stage of SRP secrets
|
1654
|
+
# as `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and
|
1655
|
+
# `TIMESTAMP`.
|
1637
1656
|
#
|
1638
1657
|
# * `CUSTOM_CHALLENGE`: This is returned if your custom authentication
|
1639
1658
|
# flow determines that the user should pass another challenge before
|
1640
1659
|
# tokens are issued. The parameters of the challenge are determined
|
1641
|
-
# by your Lambda function
|
1660
|
+
# by your Lambda function and issued in the `ChallengeParameters` of
|
1661
|
+
# a challenge response.
|
1642
1662
|
#
|
1643
1663
|
# * `DEVICE_SRP_AUTH`: Respond with the initial parameters of device
|
1644
1664
|
# SRP authentication. For more information, see [Signing in with a
|
@@ -1735,6 +1755,23 @@ module Aws::CognitoIdentityProvider
|
|
1735
1755
|
# * `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
|
1736
1756
|
# "ANSWER": "EMAIL_OTP", "USERNAME": "[username]"}`
|
1737
1757
|
#
|
1758
|
+
# WEB\_AUTHN
|
1759
|
+
#
|
1760
|
+
# : `"ChallengeName": "WEB_AUTHN", "ChallengeResponses": { "USERNAME":
|
1761
|
+
# "[username]", "CREDENTIAL": "[AuthenticationResponseJSON]"}`
|
1762
|
+
#
|
1763
|
+
# See [ AuthenticationResponseJSON][1].
|
1764
|
+
#
|
1765
|
+
# PASSWORD
|
1766
|
+
#
|
1767
|
+
# : `"ChallengeName": "PASSWORD", "ChallengeResponses": { "USERNAME":
|
1768
|
+
# "[username]", "PASSWORD": "[password]"}`
|
1769
|
+
#
|
1770
|
+
# PASSWORD\_SRP
|
1771
|
+
#
|
1772
|
+
# : `"ChallengeName": "PASSWORD_SRP", "ChallengeResponses": {
|
1773
|
+
# "USERNAME": "[username]", "SRP_A": "[SRP_A]"}`
|
1774
|
+
#
|
1738
1775
|
# SMS\_OTP
|
1739
1776
|
#
|
1740
1777
|
# : `"ChallengeName": "SMS_OTP", "ChallengeResponses":
|
@@ -1762,15 +1799,11 @@ module Aws::CognitoIdentityProvider
|
|
1762
1799
|
# "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
1763
1800
|
# [timestamp], "USERNAME": "[username]"}`
|
1764
1801
|
#
|
1765
|
-
# Add `"DEVICE_KEY"` when you sign in with a remembered device.
|
1766
|
-
#
|
1767
1802
|
# CUSTOM\_CHALLENGE
|
1768
1803
|
#
|
1769
1804
|
# : `"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
|
1770
1805
|
# {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}`
|
1771
1806
|
#
|
1772
|
-
# Add `"DEVICE_KEY"` when you sign in with a remembered device.
|
1773
|
-
#
|
1774
1807
|
# NEW\_PASSWORD\_REQUIRED
|
1775
1808
|
#
|
1776
1809
|
# : `"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
|
@@ -1820,8 +1853,8 @@ module Aws::CognitoIdentityProvider
|
|
1820
1853
|
# SELECT\_MFA\_TYPE
|
1821
1854
|
#
|
1822
1855
|
# : `"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses":
|
1823
|
-
# {"USERNAME": "[username]", "ANSWER":
|
1824
|
-
# SOFTWARE_TOKEN_MFA]"}`
|
1856
|
+
# {"USERNAME": "[username]", "ANSWER":
|
1857
|
+
# "[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]"}`
|
1825
1858
|
#
|
1826
1859
|
# For more information about `SECRET_HASH`, see [Computing secret hash
|
1827
1860
|
# values][2]. For information about `DEVICE_KEY`, see [Working with
|
@@ -1945,43 +1978,46 @@ module Aws::CognitoIdentityProvider
|
|
1945
1978
|
# Possible challenges include the following:
|
1946
1979
|
#
|
1947
1980
|
# <note markdown="1"> All of the following challenges require `USERNAME` and, when the app
|
1948
|
-
# client has a client secret, `SECRET_HASH` in the parameters.
|
1981
|
+
# client has a client secret, `SECRET_HASH` in the parameters. Include
|
1982
|
+
# a `DEVICE_KEY` for device authentication.
|
1949
1983
|
#
|
1950
1984
|
# </note>
|
1951
1985
|
#
|
1952
1986
|
# * `WEB_AUTHN`: Respond to the challenge with the results of a
|
1953
1987
|
# successful authentication with a WebAuthn authenticator, or
|
1954
|
-
# passkey
|
1955
|
-
# devices and security keys.
|
1988
|
+
# passkey, as `CREDENTIAL`. Examples of WebAuthn authenticators
|
1989
|
+
# include biometric devices and security keys.
|
1990
|
+
#
|
1991
|
+
# * `PASSWORD`: Respond with the user's password as `PASSWORD`.
|
1956
1992
|
#
|
1957
|
-
# * `
|
1958
|
-
# `USERNAME` (required), `PASSWORD` (required), `SECRET_HASH`
|
1959
|
-
# (required if the app client is configured with a client secret),
|
1960
|
-
# `DEVICE_KEY`.
|
1993
|
+
# * `PASSWORD_SRP`: Respond with the initial SRP secret as `SRP_A`.
|
1961
1994
|
#
|
1962
|
-
# * `
|
1963
|
-
# `
|
1964
|
-
#
|
1965
|
-
# `
|
1995
|
+
# * `SELECT_CHALLENGE`: Respond with a challenge selection as
|
1996
|
+
# `ANSWER`. It must be one of the challenge types in the
|
1997
|
+
# `AvailableChallenges` response parameter. Add the parameters of
|
1998
|
+
# the selected challenge, for example `USERNAME` and `SMS_OTP`.
|
1966
1999
|
#
|
1967
|
-
# * `
|
1968
|
-
# an
|
1969
|
-
# `AvailableChallenges` response parameter.
|
2000
|
+
# * `SMS_MFA`: Respond with the code that your user pool delivered in
|
2001
|
+
# an SMS message, as `SMS_MFA_CODE`
|
1970
2002
|
#
|
1971
|
-
# * `
|
1972
|
-
#
|
2003
|
+
# * `EMAIL_MFA`: Respond with the code that your user pool delivered
|
2004
|
+
# in an email message, as `EMAIL_MFA_CODE`
|
1973
2005
|
#
|
1974
|
-
# * `EMAIL_OTP`: Respond with
|
1975
|
-
#
|
2006
|
+
# * `EMAIL_OTP`: Respond with the code that your user pool delivered
|
2007
|
+
# in an email message, as `EMAIL_OTP_CODE` .
|
1976
2008
|
#
|
1977
|
-
# * `
|
1978
|
-
#
|
1979
|
-
#
|
2009
|
+
# * `SMS_OTP`: Respond with the code that your user pool delivered in
|
2010
|
+
# an SMS message, as `SMS_OTP_CODE`.
|
2011
|
+
#
|
2012
|
+
# * `PASSWORD_VERIFIER`: Respond with the second stage of SRP secrets
|
2013
|
+
# as `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and
|
2014
|
+
# `TIMESTAMP`.
|
1980
2015
|
#
|
1981
2016
|
# * `CUSTOM_CHALLENGE`: This is returned if your custom authentication
|
1982
2017
|
# flow determines that the user should pass another challenge before
|
1983
2018
|
# tokens are issued. The parameters of the challenge are determined
|
1984
|
-
# by your Lambda function
|
2019
|
+
# by your Lambda function and issued in the `ChallengeParameters` of
|
2020
|
+
# a challenge response.
|
1985
2021
|
#
|
1986
2022
|
# * `DEVICE_SRP_AUTH`: Respond with the initial parameters of device
|
1987
2023
|
# SRP authentication. For more information, see [Signing in with a
|
@@ -2784,6 +2820,23 @@ module Aws::CognitoIdentityProvider
|
|
2784
2820
|
# * `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
|
2785
2821
|
# "ANSWER": "EMAIL_OTP", "USERNAME": "[username]"}`
|
2786
2822
|
#
|
2823
|
+
# WEB\_AUTHN
|
2824
|
+
#
|
2825
|
+
# : `"ChallengeName": "WEB_AUTHN", "ChallengeResponses": { "USERNAME":
|
2826
|
+
# "[username]", "CREDENTIAL": "[AuthenticationResponseJSON]"}`
|
2827
|
+
#
|
2828
|
+
# See [ AuthenticationResponseJSON][1].
|
2829
|
+
#
|
2830
|
+
# PASSWORD
|
2831
|
+
#
|
2832
|
+
# : `"ChallengeName": "PASSWORD", "ChallengeResponses": { "USERNAME":
|
2833
|
+
# "[username]", "PASSWORD": "[password]"}`
|
2834
|
+
#
|
2835
|
+
# PASSWORD\_SRP
|
2836
|
+
#
|
2837
|
+
# : `"ChallengeName": "PASSWORD_SRP", "ChallengeResponses": {
|
2838
|
+
# "USERNAME": "[username]", "SRP_A": "[SRP_A]"}`
|
2839
|
+
#
|
2787
2840
|
# SMS\_OTP
|
2788
2841
|
#
|
2789
2842
|
# : `"ChallengeName": "SMS_OTP", "ChallengeResponses": {"SMS_OTP_CODE":
|
@@ -2811,15 +2864,11 @@ module Aws::CognitoIdentityProvider
|
|
2811
2864
|
# "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
2812
2865
|
# [timestamp], "USERNAME": "[username]"}`
|
2813
2866
|
#
|
2814
|
-
# Add `"DEVICE_KEY"` when you sign in with a remembered device.
|
2815
|
-
#
|
2816
2867
|
# CUSTOM\_CHALLENGE
|
2817
2868
|
#
|
2818
2869
|
# : `"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
|
2819
2870
|
# {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}`
|
2820
2871
|
#
|
2821
|
-
# Add `"DEVICE_KEY"` when you sign in with a remembered device.
|
2822
|
-
#
|
2823
2872
|
# NEW\_PASSWORD\_REQUIRED
|
2824
2873
|
#
|
2825
2874
|
# : `"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
|
@@ -2869,8 +2918,8 @@ module Aws::CognitoIdentityProvider
|
|
2869
2918
|
# SELECT\_MFA\_TYPE
|
2870
2919
|
#
|
2871
2920
|
# : `"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses":
|
2872
|
-
# {"USERNAME": "[username]", "ANSWER":
|
2873
|
-
# SOFTWARE_TOKEN_MFA]"}`
|
2921
|
+
# {"USERNAME": "[username]", "ANSWER":
|
2922
|
+
# "[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]"}`
|
2874
2923
|
#
|
2875
2924
|
# For more information about `SECRET_HASH`, see [Computing secret hash
|
2876
2925
|
# values][2]. For information about `DEVICE_KEY`, see [Working with user
|
@@ -3742,7 +3791,7 @@ module Aws::CognitoIdentityProvider
|
|
3742
3791
|
# @!attribute [rw] use_cognito_provided_values
|
3743
3792
|
# When true, applies the default branding style options. These default
|
3744
3793
|
# options are managed by Amazon Cognito. You can modify them later in
|
3745
|
-
# the branding
|
3794
|
+
# the branding editor.
|
3746
3795
|
#
|
3747
3796
|
# When you specify `true` for this option, you must also omit values
|
3748
3797
|
# for `Settings` and `Assets` in the request.
|
@@ -3751,6 +3800,22 @@ module Aws::CognitoIdentityProvider
|
|
3751
3800
|
# @!attribute [rw] settings
|
3752
3801
|
# A JSON file, encoded as a `Document` type, with the the settings
|
3753
3802
|
# that you want to apply to your style.
|
3803
|
+
#
|
3804
|
+
# The following components are not currently implemented and reserved
|
3805
|
+
# for future use:
|
3806
|
+
#
|
3807
|
+
# * `signUp`
|
3808
|
+
#
|
3809
|
+
# * `instructions`
|
3810
|
+
#
|
3811
|
+
# * `sessionTimerDisplay`
|
3812
|
+
#
|
3813
|
+
# * `languageSelector` (for localization, see [Managed login
|
3814
|
+
# localization)][1]
|
3815
|
+
#
|
3816
|
+
#
|
3817
|
+
#
|
3818
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization
|
3754
3819
|
# @return [Hash,Array,String,Numeric,Boolean]
|
3755
3820
|
#
|
3756
3821
|
# @!attribute [rw] assets
|
@@ -3832,6 +3897,68 @@ module Aws::CognitoIdentityProvider
|
|
3832
3897
|
include Aws::Structure
|
3833
3898
|
end
|
3834
3899
|
|
3900
|
+
# @!attribute [rw] user_pool_id
|
3901
|
+
# The ID of the user pool where you want to create terms documents.
|
3902
|
+
# @return [String]
|
3903
|
+
#
|
3904
|
+
# @!attribute [rw] client_id
|
3905
|
+
# The ID of the app client where you want to create terms documents.
|
3906
|
+
# Must be an app client in the requested user pool.
|
3907
|
+
# @return [String]
|
3908
|
+
#
|
3909
|
+
# @!attribute [rw] terms_name
|
3910
|
+
# A friendly name for the document that you want to create in the
|
3911
|
+
# current request. Must begin with `terms-of-use` or `privacy-policy`
|
3912
|
+
# as identification of the document type. Provide URLs for both
|
3913
|
+
# `terms-of-use` and `privacy-policy` in separate requests.
|
3914
|
+
# @return [String]
|
3915
|
+
#
|
3916
|
+
# @!attribute [rw] terms_source
|
3917
|
+
# This parameter is reserved for future use and currently accepts only
|
3918
|
+
# one value.
|
3919
|
+
# @return [String]
|
3920
|
+
#
|
3921
|
+
# @!attribute [rw] enforcement
|
3922
|
+
# This parameter is reserved for future use and currently accepts only
|
3923
|
+
# one value.
|
3924
|
+
# @return [String]
|
3925
|
+
#
|
3926
|
+
# @!attribute [rw] links
|
3927
|
+
# A map of URLs to languages. For each localized language that will
|
3928
|
+
# view the requested `TermsName`, assign a URL. A selection of
|
3929
|
+
# `cognito:default` displays for all languages that don't have a
|
3930
|
+
# language-specific URL.
|
3931
|
+
#
|
3932
|
+
# For example, `"cognito:default": "https://terms.example.com",
|
3933
|
+
# "cognito:spanish": "https://terms.example.com/es"`.
|
3934
|
+
# @return [Hash<String,String>]
|
3935
|
+
#
|
3936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateTermsRequest AWS API Documentation
|
3937
|
+
#
|
3938
|
+
class CreateTermsRequest < Struct.new(
|
3939
|
+
:user_pool_id,
|
3940
|
+
:client_id,
|
3941
|
+
:terms_name,
|
3942
|
+
:terms_source,
|
3943
|
+
:enforcement,
|
3944
|
+
:links)
|
3945
|
+
SENSITIVE = [:client_id]
|
3946
|
+
include Aws::Structure
|
3947
|
+
end
|
3948
|
+
|
3949
|
+
# @!attribute [rw] terms
|
3950
|
+
# A summary of your terms documents. Includes a unique identifier for
|
3951
|
+
# later changes to the terms documents.
|
3952
|
+
# @return [Types::TermsType]
|
3953
|
+
#
|
3954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateTermsResponse AWS API Documentation
|
3955
|
+
#
|
3956
|
+
class CreateTermsResponse < Struct.new(
|
3957
|
+
:terms)
|
3958
|
+
SENSITIVE = []
|
3959
|
+
include Aws::Structure
|
3960
|
+
end
|
3961
|
+
|
3835
3962
|
# Represents the request to create the user import job.
|
3836
3963
|
#
|
3837
3964
|
# @!attribute [rw] job_name
|
@@ -4813,6 +4940,24 @@ module Aws::CognitoIdentityProvider
|
|
4813
4940
|
include Aws::Structure
|
4814
4941
|
end
|
4815
4942
|
|
4943
|
+
# @!attribute [rw] terms_id
|
4944
|
+
# The ID of the terms documents that you want to delete.
|
4945
|
+
# @return [String]
|
4946
|
+
#
|
4947
|
+
# @!attribute [rw] user_pool_id
|
4948
|
+
# The ID of the user pool that contains the terms documents that you
|
4949
|
+
# want to delete.
|
4950
|
+
# @return [String]
|
4951
|
+
#
|
4952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteTermsRequest AWS API Documentation
|
4953
|
+
#
|
4954
|
+
class DeleteTermsRequest < Struct.new(
|
4955
|
+
:terms_id,
|
4956
|
+
:user_pool_id)
|
4957
|
+
SENSITIVE = []
|
4958
|
+
include Aws::Structure
|
4959
|
+
end
|
4960
|
+
|
4816
4961
|
# Represents the request to delete user attributes.
|
4817
4962
|
#
|
4818
4963
|
# @!attribute [rw] user_attribute_names
|
@@ -5119,6 +5264,37 @@ module Aws::CognitoIdentityProvider
|
|
5119
5264
|
include Aws::Structure
|
5120
5265
|
end
|
5121
5266
|
|
5267
|
+
# @!attribute [rw] terms_id
|
5268
|
+
# The ID of the terms documents that you want to describe.
|
5269
|
+
# @return [String]
|
5270
|
+
#
|
5271
|
+
# @!attribute [rw] user_pool_id
|
5272
|
+
# The ID of the user pool that contains the terms documents that you
|
5273
|
+
# want to describe.
|
5274
|
+
# @return [String]
|
5275
|
+
#
|
5276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeTermsRequest AWS API Documentation
|
5277
|
+
#
|
5278
|
+
class DescribeTermsRequest < Struct.new(
|
5279
|
+
:terms_id,
|
5280
|
+
:user_pool_id)
|
5281
|
+
SENSITIVE = []
|
5282
|
+
include Aws::Structure
|
5283
|
+
end
|
5284
|
+
|
5285
|
+
# @!attribute [rw] terms
|
5286
|
+
# A summary of the requested terms documents. Includes a unique
|
5287
|
+
# identifier for later changes to the terms documents.
|
5288
|
+
# @return [Types::TermsType]
|
5289
|
+
#
|
5290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeTermsResponse AWS API Documentation
|
5291
|
+
#
|
5292
|
+
class DescribeTermsResponse < Struct.new(
|
5293
|
+
:terms)
|
5294
|
+
SENSITIVE = []
|
5295
|
+
include Aws::Structure
|
5296
|
+
end
|
5297
|
+
|
5122
5298
|
# Represents the request to describe the user import job.
|
5123
5299
|
#
|
5124
5300
|
# @!attribute [rw] user_pool_id
|
@@ -6169,7 +6345,8 @@ module Aws::CognitoIdentityProvider
|
|
6169
6345
|
# @!attribute [rw] refresh_token
|
6170
6346
|
# A valid refresh token that can authorize the request for new tokens.
|
6171
6347
|
# When refresh token rotation is active in the requested app client,
|
6172
|
-
# this token is invalidated after the request is complete
|
6348
|
+
# this token is invalidated after the request is complete and after an
|
6349
|
+
# optional grace period.
|
6173
6350
|
# @return [String]
|
6174
6351
|
#
|
6175
6352
|
# @!attribute [rw] client_id
|
@@ -6924,31 +7101,42 @@ module Aws::CognitoIdentityProvider
|
|
6924
7101
|
# The authentication parameters. These are inputs corresponding to the
|
6925
7102
|
# `AuthFlow` that you're invoking.
|
6926
7103
|
#
|
6927
|
-
# The required values are specific to the
|
6928
|
-
# InitiateAuthRequest$AuthFlow.
|
6929
|
-
#
|
6930
7104
|
# The following are some authentication flows and their parameters.
|
6931
7105
|
# Add a `SECRET_HASH` parameter if your app client has a client
|
6932
|
-
# secret.
|
7106
|
+
# secret. Add `DEVICE_KEY` if you want to bypass multi-factor
|
7107
|
+
# authentication with a remembered device.
|
7108
|
+
#
|
7109
|
+
# USER\_AUTH
|
7110
|
+
# : * `USERNAME` (required)
|
7111
|
+
#
|
7112
|
+
# * `PREFERRED_CHALLENGE`. If you don't provide a value for
|
7113
|
+
# `PREFERRED_CHALLENGE`, Amazon Cognito responds with the
|
7114
|
+
# `AvailableChallenges` parameter that specifies the available
|
7115
|
+
# sign-in methods.
|
7116
|
+
#
|
7117
|
+
# USER\_SRP\_AUTH
|
7118
|
+
# : * `USERNAME` (required)
|
7119
|
+
#
|
7120
|
+
# * `SRP_A` (required)
|
7121
|
+
#
|
7122
|
+
# USER\_PASSWORD\_AUTH
|
7123
|
+
# : * `USERNAME` (required)
|
7124
|
+
#
|
7125
|
+
# * `PASSWORD` (required)
|
6933
7126
|
#
|
6934
|
-
#
|
6935
|
-
#
|
6936
|
-
# responds with the `AvailableChallenges` parameter that specifies
|
6937
|
-
# the available sign-in methods.
|
7127
|
+
# REFRESH\_TOKEN\_AUTH/REFRESH\_TOKEN
|
7128
|
+
# : * `REFRESH_TOKEN`(required)
|
6938
7129
|
#
|
6939
|
-
#
|
6940
|
-
# `DEVICE_KEY`.
|
7130
|
+
# ^
|
6941
7131
|
#
|
6942
|
-
#
|
6943
|
-
#
|
7132
|
+
# CUSTOM\_AUTH
|
7133
|
+
# : * `USERNAME` (required)
|
6944
7134
|
#
|
6945
|
-
#
|
6946
|
-
#
|
7135
|
+
# * `ChallengeName: SRP_A` (when doing SRP authentication before
|
7136
|
+
# custom challenges)
|
6947
7137
|
#
|
6948
|
-
#
|
6949
|
-
#
|
6950
|
-
# authentication flow with password verification, include
|
6951
|
-
# `ChallengeName: SRP_A` and `SRP_A: (The SRP_A Value)`.
|
7138
|
+
# * `SRP_A: (An SRP_A value)` (when doing SRP authentication before
|
7139
|
+
# custom challenges)
|
6952
7140
|
#
|
6953
7141
|
# For more information about `SECRET_HASH`, see [Computing secret hash
|
6954
7142
|
# values][1]. For information about `DEVICE_KEY`, see [Working with
|
@@ -7084,43 +7272,46 @@ module Aws::CognitoIdentityProvider
|
|
7084
7272
|
# Possible challenges include the following:
|
7085
7273
|
#
|
7086
7274
|
# <note markdown="1"> All of the following challenges require `USERNAME` and, when the app
|
7087
|
-
# client has a client secret, `SECRET_HASH` in the parameters.
|
7275
|
+
# client has a client secret, `SECRET_HASH` in the parameters. Include
|
7276
|
+
# a `DEVICE_KEY` for device authentication.
|
7088
7277
|
#
|
7089
7278
|
# </note>
|
7090
7279
|
#
|
7091
7280
|
# * `WEB_AUTHN`: Respond to the challenge with the results of a
|
7092
7281
|
# successful authentication with a WebAuthn authenticator, or
|
7093
|
-
# passkey
|
7094
|
-
# devices and security keys.
|
7282
|
+
# passkey, as `CREDENTIAL`. Examples of WebAuthn authenticators
|
7283
|
+
# include biometric devices and security keys.
|
7284
|
+
#
|
7285
|
+
# * `PASSWORD`: Respond with the user's password as `PASSWORD`.
|
7286
|
+
#
|
7287
|
+
# * `PASSWORD_SRP`: Respond with the initial SRP secret as `SRP_A`.
|
7095
7288
|
#
|
7096
|
-
# * `
|
7097
|
-
# `
|
7098
|
-
#
|
7099
|
-
# `
|
7289
|
+
# * `SELECT_CHALLENGE`: Respond with a challenge selection as
|
7290
|
+
# `ANSWER`. It must be one of the challenge types in the
|
7291
|
+
# `AvailableChallenges` response parameter. Add the parameters of
|
7292
|
+
# the selected challenge, for example `USERNAME` and `SMS_OTP`.
|
7100
7293
|
#
|
7101
|
-
# * `
|
7102
|
-
#
|
7103
|
-
# if the app client is configured with a client secret),
|
7104
|
-
# `DEVICE_KEY`.
|
7294
|
+
# * `SMS_MFA`: Respond with the code that your user pool delivered in
|
7295
|
+
# an SMS message, as `SMS_MFA_CODE`
|
7105
7296
|
#
|
7106
|
-
# * `
|
7107
|
-
# an
|
7108
|
-
# `AvailableChallenges` response parameter.
|
7297
|
+
# * `EMAIL_MFA`: Respond with the code that your user pool delivered
|
7298
|
+
# in an email message, as `EMAIL_MFA_CODE`
|
7109
7299
|
#
|
7110
|
-
# * `
|
7111
|
-
#
|
7300
|
+
# * `EMAIL_OTP`: Respond with the code that your user pool delivered
|
7301
|
+
# in an email message, as `EMAIL_OTP_CODE` .
|
7112
7302
|
#
|
7113
|
-
# * `
|
7114
|
-
#
|
7303
|
+
# * `SMS_OTP`: Respond with the code that your user pool delivered in
|
7304
|
+
# an SMS message, as `SMS_OTP_CODE`.
|
7115
7305
|
#
|
7116
|
-
# * `PASSWORD_VERIFIER`: Respond with
|
7117
|
-
# `PASSWORD_CLAIM_SECRET_BLOCK`, and
|
7118
|
-
#
|
7306
|
+
# * `PASSWORD_VERIFIER`: Respond with the second stage of SRP secrets
|
7307
|
+
# as `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and
|
7308
|
+
# `TIMESTAMP`.
|
7119
7309
|
#
|
7120
7310
|
# * `CUSTOM_CHALLENGE`: This is returned if your custom authentication
|
7121
7311
|
# flow determines that the user should pass another challenge before
|
7122
7312
|
# tokens are issued. The parameters of the challenge are determined
|
7123
|
-
# by your Lambda function
|
7313
|
+
# by your Lambda function and issued in the `ChallengeParameters` of
|
7314
|
+
# a challenge response.
|
7124
7315
|
#
|
7125
7316
|
# * `DEVICE_SRP_AUTH`: Respond with the initial parameters of device
|
7126
7317
|
# SRP authentication. For more information, see [Signing in with a
|
@@ -7781,6 +7972,59 @@ module Aws::CognitoIdentityProvider
|
|
7781
7972
|
include Aws::Structure
|
7782
7973
|
end
|
7783
7974
|
|
7975
|
+
# @!attribute [rw] user_pool_id
|
7976
|
+
# The ID of the user pool where you want to list terms documents.
|
7977
|
+
# @return [String]
|
7978
|
+
#
|
7979
|
+
# @!attribute [rw] max_results
|
7980
|
+
# The maximum number of terms documents that you want Amazon Cognito
|
7981
|
+
# to return in the response.
|
7982
|
+
# @return [Integer]
|
7983
|
+
#
|
7984
|
+
# @!attribute [rw] next_token
|
7985
|
+
# This API operation returns a limited number of results. The
|
7986
|
+
# pagination token is an identifier that you can present in an
|
7987
|
+
# additional API request with the same parameters. When you include
|
7988
|
+
# the pagination token, Amazon Cognito returns the next set of items
|
7989
|
+
# after the current list. Subsequent requests return a new pagination
|
7990
|
+
# token. By use of this token, you can paginate through the full list
|
7991
|
+
# of items.
|
7992
|
+
# @return [String]
|
7993
|
+
#
|
7994
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListTermsRequest AWS API Documentation
|
7995
|
+
#
|
7996
|
+
class ListTermsRequest < Struct.new(
|
7997
|
+
:user_pool_id,
|
7998
|
+
:max_results,
|
7999
|
+
:next_token)
|
8000
|
+
SENSITIVE = []
|
8001
|
+
include Aws::Structure
|
8002
|
+
end
|
8003
|
+
|
8004
|
+
# @!attribute [rw] terms
|
8005
|
+
# A summary of the requested terms documents. Includes unique
|
8006
|
+
# identifiers for later changes to the terms documents.
|
8007
|
+
# @return [Array<Types::TermsDescriptionType>]
|
8008
|
+
#
|
8009
|
+
# @!attribute [rw] next_token
|
8010
|
+
# This API operation returns a limited number of results. The
|
8011
|
+
# pagination token is an identifier that you can present in an
|
8012
|
+
# additional API request with the same parameters. When you include
|
8013
|
+
# the pagination token, Amazon Cognito returns the next set of items
|
8014
|
+
# after the current list. Subsequent requests return a new pagination
|
8015
|
+
# token. By use of this token, you can paginate through the full list
|
8016
|
+
# of items.
|
8017
|
+
# @return [String]
|
8018
|
+
#
|
8019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListTermsResponse AWS API Documentation
|
8020
|
+
#
|
8021
|
+
class ListTermsResponse < Struct.new(
|
8022
|
+
:terms,
|
8023
|
+
:next_token)
|
8024
|
+
SENSITIVE = []
|
8025
|
+
include Aws::Structure
|
8026
|
+
end
|
8027
|
+
|
7784
8028
|
# Represents the request to list the user import jobs.
|
7785
8029
|
#
|
7786
8030
|
# @!attribute [rw] user_pool_id
|
@@ -8344,7 +8588,7 @@ module Aws::CognitoIdentityProvider
|
|
8344
8588
|
# @!attribute [rw] use_cognito_provided_values
|
8345
8589
|
# When true, applies the default branding style options. This option
|
8346
8590
|
# reverts to default style options that are managed by Amazon Cognito.
|
8347
|
-
# You can modify them later in the branding
|
8591
|
+
# You can modify them later in the branding editor.
|
8348
8592
|
#
|
8349
8593
|
# When you specify `true` for this option, you must also omit values
|
8350
8594
|
# for `Settings` and `Assets` in the request.
|
@@ -8353,6 +8597,22 @@ module Aws::CognitoIdentityProvider
|
|
8353
8597
|
# @!attribute [rw] settings
|
8354
8598
|
# A JSON file, encoded as a `Document` type, with the the settings
|
8355
8599
|
# that you want to apply to your style.
|
8600
|
+
#
|
8601
|
+
# The following components are not currently implemented and reserved
|
8602
|
+
# for future use:
|
8603
|
+
#
|
8604
|
+
# * `signUp`
|
8605
|
+
#
|
8606
|
+
# * `instructions`
|
8607
|
+
#
|
8608
|
+
# * `sessionTimerDisplay`
|
8609
|
+
#
|
8610
|
+
# * `languageSelector` (for localization, see [Managed login
|
8611
|
+
# localization)][1]
|
8612
|
+
#
|
8613
|
+
#
|
8614
|
+
#
|
8615
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization
|
8356
8616
|
# @return [Hash,Array,String,Numeric,Boolean]
|
8357
8617
|
#
|
8358
8618
|
# @!attribute [rw] assets
|
@@ -9050,43 +9310,46 @@ module Aws::CognitoIdentityProvider
|
|
9050
9310
|
# Possible challenges include the following:
|
9051
9311
|
#
|
9052
9312
|
# <note markdown="1"> All of the following challenges require `USERNAME` and, when the app
|
9053
|
-
# client has a client secret, `SECRET_HASH` in the parameters.
|
9313
|
+
# client has a client secret, `SECRET_HASH` in the parameters. Include
|
9314
|
+
# a `DEVICE_KEY` for device authentication.
|
9054
9315
|
#
|
9055
9316
|
# </note>
|
9056
9317
|
#
|
9057
9318
|
# * `WEB_AUTHN`: Respond to the challenge with the results of a
|
9058
9319
|
# successful authentication with a WebAuthn authenticator, or
|
9059
|
-
# passkey
|
9060
|
-
# devices and security keys.
|
9320
|
+
# passkey, as `CREDENTIAL`. Examples of WebAuthn authenticators
|
9321
|
+
# include biometric devices and security keys.
|
9061
9322
|
#
|
9062
|
-
# * `PASSWORD`: Respond with `
|
9063
|
-
# `USERNAME` (required), `PASSWORD` (required), `SECRET_HASH`
|
9064
|
-
# (required if the app client is configured with a client secret),
|
9065
|
-
# `DEVICE_KEY`.
|
9323
|
+
# * `PASSWORD`: Respond with the user's password as `PASSWORD`.
|
9066
9324
|
#
|
9067
|
-
# * `PASSWORD_SRP`: Respond with `
|
9068
|
-
# `USERNAME` (required), `SRP_A` (required), `SECRET_HASH` (required
|
9069
|
-
# if the app client is configured with a client secret),
|
9070
|
-
# `DEVICE_KEY`.
|
9325
|
+
# * `PASSWORD_SRP`: Respond with the initial SRP secret as `SRP_A`.
|
9071
9326
|
#
|
9072
|
-
# * `SELECT_CHALLENGE`: Respond
|
9073
|
-
#
|
9074
|
-
# `AvailableChallenges` response parameter.
|
9327
|
+
# * `SELECT_CHALLENGE`: Respond with a challenge selection as
|
9328
|
+
# `ANSWER`. It must be one of the challenge types in the
|
9329
|
+
# `AvailableChallenges` response parameter. Add the parameters of
|
9330
|
+
# the selected challenge, for example `USERNAME` and `SMS_OTP`.
|
9075
9331
|
#
|
9076
|
-
# * `SMS_MFA`: Respond with
|
9077
|
-
#
|
9332
|
+
# * `SMS_MFA`: Respond with the code that your user pool delivered in
|
9333
|
+
# an SMS message, as `SMS_MFA_CODE`
|
9078
9334
|
#
|
9079
|
-
# * `
|
9080
|
-
#
|
9335
|
+
# * `EMAIL_MFA`: Respond with the code that your user pool delivered
|
9336
|
+
# in an email message, as `EMAIL_MFA_CODE`
|
9081
9337
|
#
|
9082
|
-
# * `
|
9083
|
-
#
|
9084
|
-
#
|
9338
|
+
# * `EMAIL_OTP`: Respond with the code that your user pool delivered
|
9339
|
+
# in an email message, as `EMAIL_OTP_CODE` .
|
9340
|
+
#
|
9341
|
+
# * `SMS_OTP`: Respond with the code that your user pool delivered in
|
9342
|
+
# an SMS message, as `SMS_OTP_CODE`.
|
9343
|
+
#
|
9344
|
+
# * `PASSWORD_VERIFIER`: Respond with the second stage of SRP secrets
|
9345
|
+
# as `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and
|
9346
|
+
# `TIMESTAMP`.
|
9085
9347
|
#
|
9086
9348
|
# * `CUSTOM_CHALLENGE`: This is returned if your custom authentication
|
9087
9349
|
# flow determines that the user should pass another challenge before
|
9088
9350
|
# tokens are issued. The parameters of the challenge are determined
|
9089
|
-
# by your Lambda function
|
9351
|
+
# by your Lambda function and issued in the `ChallengeParameters` of
|
9352
|
+
# a challenge response.
|
9090
9353
|
#
|
9091
9354
|
# * `DEVICE_SRP_AUTH`: Respond with the initial parameters of device
|
9092
9355
|
# SRP authentication. For more information, see [Signing in with a
|
@@ -9193,6 +9456,23 @@ module Aws::CognitoIdentityProvider
|
|
9193
9456
|
# * `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
|
9194
9457
|
# "ANSWER": "EMAIL_OTP", "USERNAME": "[username]"}`
|
9195
9458
|
#
|
9459
|
+
# WEB\_AUTHN
|
9460
|
+
#
|
9461
|
+
# : `"ChallengeName": "WEB_AUTHN", "ChallengeResponses": { "USERNAME":
|
9462
|
+
# "[username]", "CREDENTIAL": "[AuthenticationResponseJSON]"}`
|
9463
|
+
#
|
9464
|
+
# See [ AuthenticationResponseJSON][1].
|
9465
|
+
#
|
9466
|
+
# PASSWORD
|
9467
|
+
#
|
9468
|
+
# : `"ChallengeName": "PASSWORD", "ChallengeResponses": { "USERNAME":
|
9469
|
+
# "[username]", "PASSWORD": "[password]"}`
|
9470
|
+
#
|
9471
|
+
# PASSWORD\_SRP
|
9472
|
+
#
|
9473
|
+
# : `"ChallengeName": "PASSWORD_SRP", "ChallengeResponses": {
|
9474
|
+
# "USERNAME": "[username]", "SRP_A": "[SRP_A]"}`
|
9475
|
+
#
|
9196
9476
|
# SMS\_OTP
|
9197
9477
|
#
|
9198
9478
|
# : `"ChallengeName": "SMS_OTP", "ChallengeResponses":
|
@@ -9220,15 +9500,11 @@ module Aws::CognitoIdentityProvider
|
|
9220
9500
|
# "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
9221
9501
|
# [timestamp], "USERNAME": "[username]"}`
|
9222
9502
|
#
|
9223
|
-
# Add `"DEVICE_KEY"` when you sign in with a remembered device.
|
9224
|
-
#
|
9225
9503
|
# CUSTOM\_CHALLENGE
|
9226
9504
|
#
|
9227
9505
|
# : `"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
|
9228
9506
|
# {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}`
|
9229
9507
|
#
|
9230
|
-
# Add `"DEVICE_KEY"` when you sign in with a remembered device.
|
9231
|
-
#
|
9232
9508
|
# NEW\_PASSWORD\_REQUIRED
|
9233
9509
|
#
|
9234
9510
|
# : `"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
|
@@ -9278,8 +9554,8 @@ module Aws::CognitoIdentityProvider
|
|
9278
9554
|
# SELECT\_MFA\_TYPE
|
9279
9555
|
#
|
9280
9556
|
# : `"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses":
|
9281
|
-
# {"USERNAME": "[username]", "ANSWER":
|
9282
|
-
# SOFTWARE_TOKEN_MFA]"}`
|
9557
|
+
# {"USERNAME": "[username]", "ANSWER":
|
9558
|
+
# "[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]"}`
|
9283
9559
|
#
|
9284
9560
|
# For more information about `SECRET_HASH`, see [Computing secret hash
|
9285
9561
|
# values][2]. For information about `DEVICE_KEY`, see [Working with
|
@@ -9376,43 +9652,46 @@ module Aws::CognitoIdentityProvider
|
|
9376
9652
|
# Possible challenges include the following:
|
9377
9653
|
#
|
9378
9654
|
# <note markdown="1"> All of the following challenges require `USERNAME` and, when the app
|
9379
|
-
# client has a client secret, `SECRET_HASH` in the parameters.
|
9655
|
+
# client has a client secret, `SECRET_HASH` in the parameters. Include
|
9656
|
+
# a `DEVICE_KEY` for device authentication.
|
9380
9657
|
#
|
9381
9658
|
# </note>
|
9382
9659
|
#
|
9383
9660
|
# * `WEB_AUTHN`: Respond to the challenge with the results of a
|
9384
9661
|
# successful authentication with a WebAuthn authenticator, or
|
9385
|
-
# passkey
|
9386
|
-
# devices and security keys.
|
9662
|
+
# passkey, as `CREDENTIAL`. Examples of WebAuthn authenticators
|
9663
|
+
# include biometric devices and security keys.
|
9664
|
+
#
|
9665
|
+
# * `PASSWORD`: Respond with the user's password as `PASSWORD`.
|
9666
|
+
#
|
9667
|
+
# * `PASSWORD_SRP`: Respond with the initial SRP secret as `SRP_A`.
|
9387
9668
|
#
|
9388
|
-
# * `
|
9389
|
-
# `
|
9390
|
-
#
|
9391
|
-
# `
|
9669
|
+
# * `SELECT_CHALLENGE`: Respond with a challenge selection as
|
9670
|
+
# `ANSWER`. It must be one of the challenge types in the
|
9671
|
+
# `AvailableChallenges` response parameter. Add the parameters of
|
9672
|
+
# the selected challenge, for example `USERNAME` and `SMS_OTP`.
|
9392
9673
|
#
|
9393
|
-
# * `
|
9394
|
-
#
|
9395
|
-
# if the app client is configured with a client secret),
|
9396
|
-
# `DEVICE_KEY`.
|
9674
|
+
# * `SMS_MFA`: Respond with the code that your user pool delivered in
|
9675
|
+
# an SMS message, as `SMS_MFA_CODE`
|
9397
9676
|
#
|
9398
|
-
# * `
|
9399
|
-
# an
|
9400
|
-
# `AvailableChallenges` response parameter.
|
9677
|
+
# * `EMAIL_MFA`: Respond with the code that your user pool delivered
|
9678
|
+
# in an email message, as `EMAIL_MFA_CODE`
|
9401
9679
|
#
|
9402
|
-
# * `
|
9403
|
-
#
|
9680
|
+
# * `EMAIL_OTP`: Respond with the code that your user pool delivered
|
9681
|
+
# in an email message, as `EMAIL_OTP_CODE` .
|
9404
9682
|
#
|
9405
|
-
# * `
|
9406
|
-
#
|
9683
|
+
# * `SMS_OTP`: Respond with the code that your user pool delivered in
|
9684
|
+
# an SMS message, as `SMS_OTP_CODE`.
|
9407
9685
|
#
|
9408
|
-
# * `PASSWORD_VERIFIER`: Respond with
|
9409
|
-
# `PASSWORD_CLAIM_SECRET_BLOCK`, and
|
9410
|
-
#
|
9686
|
+
# * `PASSWORD_VERIFIER`: Respond with the second stage of SRP secrets
|
9687
|
+
# as `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and
|
9688
|
+
# `TIMESTAMP`.
|
9411
9689
|
#
|
9412
9690
|
# * `CUSTOM_CHALLENGE`: This is returned if your custom authentication
|
9413
9691
|
# flow determines that the user should pass another challenge before
|
9414
9692
|
# tokens are issued. The parameters of the challenge are determined
|
9415
|
-
# by your Lambda function
|
9693
|
+
# by your Lambda function and issued in the `ChallengeParameters` of
|
9694
|
+
# a challenge response.
|
9416
9695
|
#
|
9417
9696
|
# * `DEVICE_SRP_AUTH`: Respond with the initial parameters of device
|
9418
9697
|
# SRP authentication. For more information, see [Signing in with a
|
@@ -10575,6 +10854,140 @@ module Aws::CognitoIdentityProvider
|
|
10575
10854
|
#
|
10576
10855
|
class TagResourceResponse < Aws::EmptyStructure; end
|
10577
10856
|
|
10857
|
+
# The details of a set of terms documents. For more information, see
|
10858
|
+
# [Terms documents][1].
|
10859
|
+
#
|
10860
|
+
#
|
10861
|
+
#
|
10862
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents
|
10863
|
+
#
|
10864
|
+
# @!attribute [rw] terms_id
|
10865
|
+
# The ID of the requested terms documents.
|
10866
|
+
# @return [String]
|
10867
|
+
#
|
10868
|
+
# @!attribute [rw] terms_name
|
10869
|
+
# The type and friendly name of the requested terms documents.
|
10870
|
+
# @return [String]
|
10871
|
+
#
|
10872
|
+
# @!attribute [rw] enforcement
|
10873
|
+
# This parameter is reserved for future use and currently accepts one
|
10874
|
+
# value.
|
10875
|
+
# @return [String]
|
10876
|
+
#
|
10877
|
+
# @!attribute [rw] creation_date
|
10878
|
+
# The date and time when the item was created. Amazon Cognito returns
|
10879
|
+
# this timestamp in UNIX epoch time format. Your SDK might render the
|
10880
|
+
# output in a human-readable format like ISO 8601 or a Java `Date`
|
10881
|
+
# object.
|
10882
|
+
# @return [Time]
|
10883
|
+
#
|
10884
|
+
# @!attribute [rw] last_modified_date
|
10885
|
+
# The date and time when the item was modified. Amazon Cognito returns
|
10886
|
+
# this timestamp in UNIX epoch time format. Your SDK might render the
|
10887
|
+
# output in a human-readable format like ISO 8601 or a Java `Date`
|
10888
|
+
# object.
|
10889
|
+
# @return [Time]
|
10890
|
+
#
|
10891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/TermsDescriptionType AWS API Documentation
|
10892
|
+
#
|
10893
|
+
class TermsDescriptionType < Struct.new(
|
10894
|
+
:terms_id,
|
10895
|
+
:terms_name,
|
10896
|
+
:enforcement,
|
10897
|
+
:creation_date,
|
10898
|
+
:last_modified_date)
|
10899
|
+
SENSITIVE = []
|
10900
|
+
include Aws::Structure
|
10901
|
+
end
|
10902
|
+
|
10903
|
+
# Terms document names must be unique to the app client. This exception
|
10904
|
+
# is thrown when you attempt to create terms documents with a duplicate
|
10905
|
+
# `TermsName`.
|
10906
|
+
#
|
10907
|
+
# @!attribute [rw] message
|
10908
|
+
# @return [String]
|
10909
|
+
#
|
10910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/TermsExistsException AWS API Documentation
|
10911
|
+
#
|
10912
|
+
class TermsExistsException < Struct.new(
|
10913
|
+
:message)
|
10914
|
+
SENSITIVE = []
|
10915
|
+
include Aws::Structure
|
10916
|
+
end
|
10917
|
+
|
10918
|
+
# The details of a set of terms documents. For more information, see
|
10919
|
+
# [Terms documents][1].
|
10920
|
+
#
|
10921
|
+
#
|
10922
|
+
#
|
10923
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents
|
10924
|
+
#
|
10925
|
+
# @!attribute [rw] terms_id
|
10926
|
+
# The ID of the terms documents.
|
10927
|
+
# @return [String]
|
10928
|
+
#
|
10929
|
+
# @!attribute [rw] user_pool_id
|
10930
|
+
# The ID of the user pool that contains the terms documents.
|
10931
|
+
# @return [String]
|
10932
|
+
#
|
10933
|
+
# @!attribute [rw] client_id
|
10934
|
+
# The ID of the app client that the terms documents are assigned to.
|
10935
|
+
# @return [String]
|
10936
|
+
#
|
10937
|
+
# @!attribute [rw] terms_name
|
10938
|
+
# The type and friendly name of the terms documents.
|
10939
|
+
# @return [String]
|
10940
|
+
#
|
10941
|
+
# @!attribute [rw] terms_source
|
10942
|
+
# This parameter is reserved for future use and currently accepts one
|
10943
|
+
# value.
|
10944
|
+
# @return [String]
|
10945
|
+
#
|
10946
|
+
# @!attribute [rw] enforcement
|
10947
|
+
# This parameter is reserved for future use and currently accepts one
|
10948
|
+
# value.
|
10949
|
+
# @return [String]
|
10950
|
+
#
|
10951
|
+
# @!attribute [rw] links
|
10952
|
+
# A map of URLs to languages. For each localized language that will
|
10953
|
+
# view the requested `TermsName`, assign a URL. A selection of
|
10954
|
+
# `cognito:default` displays for all languages that don't have a
|
10955
|
+
# language-specific URL.
|
10956
|
+
#
|
10957
|
+
# For example, `"cognito:default": "https://terms.example.com",
|
10958
|
+
# "cognito:spanish": "https://terms.example.com/es"`.
|
10959
|
+
# @return [Hash<String,String>]
|
10960
|
+
#
|
10961
|
+
# @!attribute [rw] creation_date
|
10962
|
+
# The date and time when the item was created. Amazon Cognito returns
|
10963
|
+
# this timestamp in UNIX epoch time format. Your SDK might render the
|
10964
|
+
# output in a human-readable format like ISO 8601 or a Java `Date`
|
10965
|
+
# object.
|
10966
|
+
# @return [Time]
|
10967
|
+
#
|
10968
|
+
# @!attribute [rw] last_modified_date
|
10969
|
+
# The date and time when the item was modified. Amazon Cognito returns
|
10970
|
+
# this timestamp in UNIX epoch time format. Your SDK might render the
|
10971
|
+
# output in a human-readable format like ISO 8601 or a Java `Date`
|
10972
|
+
# object.
|
10973
|
+
# @return [Time]
|
10974
|
+
#
|
10975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/TermsType AWS API Documentation
|
10976
|
+
#
|
10977
|
+
class TermsType < Struct.new(
|
10978
|
+
:terms_id,
|
10979
|
+
:user_pool_id,
|
10980
|
+
:client_id,
|
10981
|
+
:terms_name,
|
10982
|
+
:terms_source,
|
10983
|
+
:enforcement,
|
10984
|
+
:links,
|
10985
|
+
:creation_date,
|
10986
|
+
:last_modified_date)
|
10987
|
+
SENSITIVE = [:client_id]
|
10988
|
+
include Aws::Structure
|
10989
|
+
end
|
10990
|
+
|
10578
10991
|
# This exception is thrown when you've attempted to change your feature
|
10579
10992
|
# plan but the operation isn't permitted.
|
10580
10993
|
#
|
@@ -11161,7 +11574,7 @@ module Aws::CognitoIdentityProvider
|
|
11161
11574
|
# @!attribute [rw] use_cognito_provided_values
|
11162
11575
|
# When `true`, applies the default branding style options. This option
|
11163
11576
|
# reverts to default style options that are managed by Amazon Cognito.
|
11164
|
-
# You can modify them later in the branding
|
11577
|
+
# You can modify them later in the branding editor.
|
11165
11578
|
#
|
11166
11579
|
# When you specify `true` for this option, you must also omit values
|
11167
11580
|
# for `Settings` and `Assets` in the request.
|
@@ -11170,6 +11583,22 @@ module Aws::CognitoIdentityProvider
|
|
11170
11583
|
# @!attribute [rw] settings
|
11171
11584
|
# A JSON file, encoded as a `Document` type, with the the settings
|
11172
11585
|
# that you want to apply to your style.
|
11586
|
+
#
|
11587
|
+
# The following components are not currently implemented and reserved
|
11588
|
+
# for future use:
|
11589
|
+
#
|
11590
|
+
# * `signUp`
|
11591
|
+
#
|
11592
|
+
# * `instructions`
|
11593
|
+
#
|
11594
|
+
# * `sessionTimerDisplay`
|
11595
|
+
#
|
11596
|
+
# * `languageSelector` (for localization, see [Managed login
|
11597
|
+
# localization)][1]
|
11598
|
+
#
|
11599
|
+
#
|
11600
|
+
#
|
11601
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization
|
11173
11602
|
# @return [Hash,Array,String,Numeric,Boolean]
|
11174
11603
|
#
|
11175
11604
|
# @!attribute [rw] assets
|
@@ -11250,6 +11679,65 @@ module Aws::CognitoIdentityProvider
|
|
11250
11679
|
include Aws::Structure
|
11251
11680
|
end
|
11252
11681
|
|
11682
|
+
# @!attribute [rw] terms_id
|
11683
|
+
# The ID of the terms document that you want to update.
|
11684
|
+
# @return [String]
|
11685
|
+
#
|
11686
|
+
# @!attribute [rw] user_pool_id
|
11687
|
+
# The ID of the user pool that contains the terms that you want to
|
11688
|
+
# update.
|
11689
|
+
# @return [String]
|
11690
|
+
#
|
11691
|
+
# @!attribute [rw] terms_name
|
11692
|
+
# The new name that you want to apply to the requested terms
|
11693
|
+
# documents.
|
11694
|
+
# @return [String]
|
11695
|
+
#
|
11696
|
+
# @!attribute [rw] terms_source
|
11697
|
+
# This parameter is reserved for future use and currently accepts only
|
11698
|
+
# one value.
|
11699
|
+
# @return [String]
|
11700
|
+
#
|
11701
|
+
# @!attribute [rw] enforcement
|
11702
|
+
# This parameter is reserved for future use and currently accepts only
|
11703
|
+
# one value.
|
11704
|
+
# @return [String]
|
11705
|
+
#
|
11706
|
+
# @!attribute [rw] links
|
11707
|
+
# A map of URLs to languages. For each localized language that will
|
11708
|
+
# view the requested `TermsName`, assign a URL. A selection of
|
11709
|
+
# `cognito:default` displays for all languages that don't have a
|
11710
|
+
# language-specific URL.
|
11711
|
+
#
|
11712
|
+
# For example, `"cognito:default": "https://terms.example.com",
|
11713
|
+
# "cognito:spanish": "https://terms.example.com/es"`.
|
11714
|
+
# @return [Hash<String,String>]
|
11715
|
+
#
|
11716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateTermsRequest AWS API Documentation
|
11717
|
+
#
|
11718
|
+
class UpdateTermsRequest < Struct.new(
|
11719
|
+
:terms_id,
|
11720
|
+
:user_pool_id,
|
11721
|
+
:terms_name,
|
11722
|
+
:terms_source,
|
11723
|
+
:enforcement,
|
11724
|
+
:links)
|
11725
|
+
SENSITIVE = []
|
11726
|
+
include Aws::Structure
|
11727
|
+
end
|
11728
|
+
|
11729
|
+
# @!attribute [rw] terms
|
11730
|
+
# A summary of the updates to your terms documents.
|
11731
|
+
# @return [Types::TermsType]
|
11732
|
+
#
|
11733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateTermsResponse AWS API Documentation
|
11734
|
+
#
|
11735
|
+
class UpdateTermsResponse < Struct.new(
|
11736
|
+
:terms)
|
11737
|
+
SENSITIVE = []
|
11738
|
+
include Aws::Structure
|
11739
|
+
end
|
11740
|
+
|
11253
11741
|
# Represents the request to update user attributes.
|
11254
11742
|
#
|
11255
11743
|
# @!attribute [rw] user_attributes
|
@@ -11781,7 +12269,7 @@ module Aws::CognitoIdentityProvider
|
|
11781
12269
|
# @!attribute [rw] managed_login_version
|
11782
12270
|
# A version number that indicates the state of managed login for your
|
11783
12271
|
# domain. Version `1` is hosted UI (classic). Version `2` is the newer
|
11784
|
-
# managed login with the branding
|
12272
|
+
# managed login with the branding editor. For more information, see
|
11785
12273
|
# [Managed login][1].
|
11786
12274
|
#
|
11787
12275
|
#
|
@@ -11818,7 +12306,7 @@ module Aws::CognitoIdentityProvider
|
|
11818
12306
|
# @!attribute [rw] managed_login_version
|
11819
12307
|
# A version number that indicates the state of managed login for your
|
11820
12308
|
# domain. Version `1` is hosted UI (classic). Version `2` is the newer
|
11821
|
-
# managed login with the branding
|
12309
|
+
# managed login with the branding editor. For more information, see
|
11822
12310
|
# [Managed login][1].
|
11823
12311
|
#
|
11824
12312
|
#
|