aws-sdk-cognitoidentityprovider 1.27.0 → 1.28.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
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 201c2dae29af53f1d9b0a56accf6abd58bfe4063
|
4
|
+
data.tar.gz: e7c0371129e3e44fd16d55a738fa887d3c79235a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ad161717df9a0fa462795286b7b488f4e452837fdf755eba0f95f7f2f7dc0b8764c1d06a22f1740b748ede3fcf3a00f47dcaad5417b32ed7876707236ea74b98
|
7
|
+
data.tar.gz: d0984dc7926258b3bb85c70f346322a27bde345cad6804d18f8a048a8d3f225c71e549cc5f26d7775d887fddf5965259416eb584f57b4017880d027b9e80874a
|
@@ -975,6 +975,11 @@ module Aws::CognitoIdentityProvider
|
|
975
975
|
# set, this flow will invoke the user migration Lambda if the USERNAME
|
976
976
|
# is not found in the user pool.
|
977
977
|
#
|
978
|
+
# * `ADMIN_USER_PASSWORD_AUTH`\: Admin-based user password
|
979
|
+
# authentication. This replaces the `ADMIN_NO_SRP_AUTH` authentication
|
980
|
+
# flow. In this flow, Cognito receives the password in the request
|
981
|
+
# instead of using the SRP process to verify passwords.
|
982
|
+
#
|
978
983
|
# @option params [Hash<String,String>] :auth_parameters
|
979
984
|
# The authentication parameters. These are inputs corresponding to the
|
980
985
|
# `AuthFlow` that you are invoking. The required values depend on the
|
@@ -1079,7 +1084,7 @@ module Aws::CognitoIdentityProvider
|
|
1079
1084
|
# resp = client.admin_initiate_auth({
|
1080
1085
|
# user_pool_id: "UserPoolIdType", # required
|
1081
1086
|
# client_id: "ClientIdType", # required
|
1082
|
-
# auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH
|
1087
|
+
# auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
|
1083
1088
|
# auth_parameters: {
|
1084
1089
|
# "StringType" => "StringType",
|
1085
1090
|
# },
|
@@ -2126,14 +2131,14 @@ module Aws::CognitoIdentityProvider
|
|
2126
2131
|
#
|
2127
2132
|
# You create custom workflows by assigning AWS Lambda functions to user
|
2128
2133
|
# pool triggers. When you use the ConfirmForgotPassword API action,
|
2129
|
-
# Amazon Cognito invokes the
|
2130
|
-
# confirmation*
|
2131
|
-
#
|
2132
|
-
#
|
2133
|
-
#
|
2134
|
-
#
|
2135
|
-
#
|
2136
|
-
#
|
2134
|
+
# Amazon Cognito invokes the function that is assigned to the *post
|
2135
|
+
# confirmation* trigger. When Amazon Cognito invokes this function, it
|
2136
|
+
# passes a JSON payload, which the function receives as input. This
|
2137
|
+
# payload contains a `clientMetadata` attribute, which provides the data
|
2138
|
+
# that you assigned to the ClientMetadata parameter in your
|
2139
|
+
# ConfirmForgotPassword request. In your function code in AWS Lambda,
|
2140
|
+
# you can process the `clientMetadata` value to enhance your workflow
|
2141
|
+
# for your specific needs.
|
2137
2142
|
#
|
2138
2143
|
# For more information, see [Customizing User Pool Workflows with Lambda
|
2139
2144
|
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
@@ -2826,7 +2831,29 @@ module Aws::CognitoIdentityProvider
|
|
2826
2831
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html
|
2827
2832
|
#
|
2828
2833
|
# @option params [Array<String>] :explicit_auth_flows
|
2829
|
-
# The
|
2834
|
+
# The authentication flows that are supported by the user pool clients.
|
2835
|
+
# Flow names without the `ALLOW_` prefix are deprecated in favor of new
|
2836
|
+
# names with the `ALLOW_` prefix. Note that values with `ALLOW_` prefix
|
2837
|
+
# cannot be used along with values without `ALLOW_` prefix.
|
2838
|
+
#
|
2839
|
+
# Valid values include:
|
2840
|
+
#
|
2841
|
+
# * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user password
|
2842
|
+
# authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting
|
2843
|
+
# replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication
|
2844
|
+
# flow, Cognito receives the password in the request instead of using
|
2845
|
+
# the SRP (Secure Remote Password protocol) protocol to verify
|
2846
|
+
# passwords.
|
2847
|
+
#
|
2848
|
+
# * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
|
2849
|
+
#
|
2850
|
+
# * `ALLOW_USER_PASSWORD_AUTH`\: Enable user password-based
|
2851
|
+
# authentication. In this flow, Cognito receives the password in the
|
2852
|
+
# request instead of using the SRP protocol to verify passwords.
|
2853
|
+
#
|
2854
|
+
# * `ALLOW_USER_SRP_AUTH`\: Enable SRP based authentication.
|
2855
|
+
#
|
2856
|
+
# * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
|
2830
2857
|
#
|
2831
2858
|
# @option params [Array<String>] :supported_identity_providers
|
2832
2859
|
# A list of provider names for the identity providers that are supported
|
@@ -2902,6 +2929,48 @@ module Aws::CognitoIdentityProvider
|
|
2902
2929
|
# The Amazon Pinpoint analytics configuration for collecting metrics for
|
2903
2930
|
# this user pool.
|
2904
2931
|
#
|
2932
|
+
# @option params [String] :prevent_user_existence_errors
|
2933
|
+
# Use this setting to choose which errors and responses are returned by
|
2934
|
+
# Cognito APIs during authentication, account confirmation, and password
|
2935
|
+
# recovery when the user does not exist in the user pool. When set to
|
2936
|
+
# `ENABLED` and the user does not exist, authentication returns an error
|
2937
|
+
# indicating either the username or password was incorrect, and account
|
2938
|
+
# confirmation and password recovery return a response indicating a code
|
2939
|
+
# was sent to a simulated destination. When set to `LEGACY`, those APIs
|
2940
|
+
# will return a `UserNotFoundException` exception if the user does not
|
2941
|
+
# exist in the user pool.
|
2942
|
+
#
|
2943
|
+
# Valid values include:
|
2944
|
+
#
|
2945
|
+
# * `ENABLED` - This prevents user existence-related errors.
|
2946
|
+
#
|
2947
|
+
# * `LEGACY` - This represents the old behavior of Cognito where user
|
2948
|
+
# existence related errors are not prevented.
|
2949
|
+
#
|
2950
|
+
# This setting affects the behavior of following APIs:
|
2951
|
+
#
|
2952
|
+
# * AdminInitiateAuth
|
2953
|
+
#
|
2954
|
+
# * AdminRespondToAuthChallenge
|
2955
|
+
#
|
2956
|
+
# * InitiateAuth
|
2957
|
+
#
|
2958
|
+
# * RespondToAuthChallenge
|
2959
|
+
#
|
2960
|
+
# * ForgotPassword
|
2961
|
+
#
|
2962
|
+
# * ConfirmForgotPassword
|
2963
|
+
#
|
2964
|
+
# * ConfirmSignUp
|
2965
|
+
#
|
2966
|
+
# * ResendConfirmationCode
|
2967
|
+
#
|
2968
|
+
# <note markdown="1"> After January 1st 2020, the value of `PreventUserExistenceErrors` will
|
2969
|
+
# default to `ENABLED` for newly created user pool clients if no value
|
2970
|
+
# is provided.
|
2971
|
+
#
|
2972
|
+
# </note>
|
2973
|
+
#
|
2905
2974
|
# @return [Types::CreateUserPoolClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2906
2975
|
#
|
2907
2976
|
# * {Types::CreateUserPoolClientResponse#user_pool_client #user_pool_client} => Types::UserPoolClientType
|
@@ -2915,7 +2984,7 @@ module Aws::CognitoIdentityProvider
|
|
2915
2984
|
# refresh_token_validity: 1,
|
2916
2985
|
# read_attributes: ["ClientPermissionType"],
|
2917
2986
|
# write_attributes: ["ClientPermissionType"],
|
2918
|
-
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH
|
2987
|
+
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH
|
2919
2988
|
# supported_identity_providers: ["ProviderNameType"],
|
2920
2989
|
# callback_urls: ["RedirectUrlType"],
|
2921
2990
|
# logout_urls: ["RedirectUrlType"],
|
@@ -2929,6 +2998,7 @@ module Aws::CognitoIdentityProvider
|
|
2929
2998
|
# external_id: "StringType", # required
|
2930
2999
|
# user_data_shared: false,
|
2931
3000
|
# },
|
3001
|
+
# prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
|
2932
3002
|
# })
|
2933
3003
|
#
|
2934
3004
|
# @example Response structure
|
@@ -2945,7 +3015,7 @@ module Aws::CognitoIdentityProvider
|
|
2945
3015
|
# resp.user_pool_client.write_attributes #=> Array
|
2946
3016
|
# resp.user_pool_client.write_attributes[0] #=> String
|
2947
3017
|
# resp.user_pool_client.explicit_auth_flows #=> Array
|
2948
|
-
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH"
|
3018
|
+
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH"
|
2949
3019
|
# resp.user_pool_client.supported_identity_providers #=> Array
|
2950
3020
|
# resp.user_pool_client.supported_identity_providers[0] #=> String
|
2951
3021
|
# resp.user_pool_client.callback_urls #=> Array
|
@@ -2962,6 +3032,7 @@ module Aws::CognitoIdentityProvider
|
|
2962
3032
|
# resp.user_pool_client.analytics_configuration.role_arn #=> String
|
2963
3033
|
# resp.user_pool_client.analytics_configuration.external_id #=> String
|
2964
3034
|
# resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
|
3035
|
+
# resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
|
2965
3036
|
#
|
2966
3037
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClient AWS API Documentation
|
2967
3038
|
#
|
@@ -3543,7 +3614,7 @@ module Aws::CognitoIdentityProvider
|
|
3543
3614
|
# resp.user_pool_client.write_attributes #=> Array
|
3544
3615
|
# resp.user_pool_client.write_attributes[0] #=> String
|
3545
3616
|
# resp.user_pool_client.explicit_auth_flows #=> Array
|
3546
|
-
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH"
|
3617
|
+
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH"
|
3547
3618
|
# resp.user_pool_client.supported_identity_providers #=> Array
|
3548
3619
|
# resp.user_pool_client.supported_identity_providers[0] #=> String
|
3549
3620
|
# resp.user_pool_client.callback_urls #=> Array
|
@@ -3560,6 +3631,7 @@ module Aws::CognitoIdentityProvider
|
|
3560
3631
|
# resp.user_pool_client.analytics_configuration.role_arn #=> String
|
3561
3632
|
# resp.user_pool_client.analytics_configuration.external_id #=> String
|
3562
3633
|
# resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
|
3634
|
+
# resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
|
3563
3635
|
#
|
3564
3636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClient AWS API Documentation
|
3565
3637
|
#
|
@@ -4166,6 +4238,11 @@ module Aws::CognitoIdentityProvider
|
|
4166
4238
|
# set, this flow will invoke the user migration Lambda if the USERNAME
|
4167
4239
|
# is not found in the user pool.
|
4168
4240
|
#
|
4241
|
+
# * `ADMIN_USER_PASSWORD_AUTH`\: Admin-based user password
|
4242
|
+
# authentication. This replaces the `ADMIN_NO_SRP_AUTH` authentication
|
4243
|
+
# flow. In this flow, Cognito receives the password in the request
|
4244
|
+
# instead of using the SRP process to verify passwords.
|
4245
|
+
#
|
4169
4246
|
# `ADMIN_NO_SRP_AUTH` is not a valid value.
|
4170
4247
|
#
|
4171
4248
|
# @option params [Hash<String,String>] :auth_parameters
|
@@ -4269,7 +4346,7 @@ module Aws::CognitoIdentityProvider
|
|
4269
4346
|
# @example Request syntax with placeholder values
|
4270
4347
|
#
|
4271
4348
|
# resp = client.initiate_auth({
|
4272
|
-
# auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH
|
4349
|
+
# auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
|
4273
4350
|
# auth_parameters: {
|
4274
4351
|
# "StringType" => "StringType",
|
4275
4352
|
# },
|
@@ -5774,6 +5851,9 @@ module Aws::CognitoIdentityProvider
|
|
5774
5851
|
#
|
5775
5852
|
# Calling this action requires developer credentials.
|
5776
5853
|
#
|
5854
|
+
# If you don't provide a value for an attribute, it will be set to the
|
5855
|
+
# default value.
|
5856
|
+
#
|
5777
5857
|
# @option params [required, String] :group_name
|
5778
5858
|
# The name of the group.
|
5779
5859
|
#
|
@@ -5886,6 +5966,9 @@ module Aws::CognitoIdentityProvider
|
|
5886
5966
|
# Updates the name and scopes of resource server. All other fields are
|
5887
5967
|
# read-only.
|
5888
5968
|
#
|
5969
|
+
# If you don't provide a value for an attribute, it will be set to the
|
5970
|
+
# default value.
|
5971
|
+
#
|
5889
5972
|
# @option params [required, String] :user_pool_id
|
5890
5973
|
# The user pool ID for the user pool.
|
5891
5974
|
#
|
@@ -5951,14 +6034,14 @@ module Aws::CognitoIdentityProvider
|
|
5951
6034
|
#
|
5952
6035
|
# You create custom workflows by assigning AWS Lambda functions to user
|
5953
6036
|
# pool triggers. When you use the UpdateUserAttributes API action,
|
5954
|
-
# Amazon Cognito invokes the
|
5955
|
-
# message*
|
5956
|
-
#
|
5957
|
-
#
|
5958
|
-
#
|
5959
|
-
#
|
5960
|
-
#
|
5961
|
-
#
|
6037
|
+
# Amazon Cognito invokes the function that is assigned to the *custom
|
6038
|
+
# message* trigger. When Amazon Cognito invokes this function, it passes
|
6039
|
+
# a JSON payload, which the function receives as input. This payload
|
6040
|
+
# contains a `clientMetadata` attribute, which provides the data that
|
6041
|
+
# you assigned to the ClientMetadata parameter in your
|
6042
|
+
# UpdateUserAttributes request. In your function code in AWS Lambda, you
|
6043
|
+
# can process the `clientMetadata` value to enhance your workflow for
|
6044
|
+
# your specific needs.
|
5962
6045
|
#
|
5963
6046
|
# For more information, see [Customizing User Pool Workflows with Lambda
|
5964
6047
|
# Triggers][1] in the *Amazon Cognito Developer Guide*.
|
@@ -6018,9 +6101,11 @@ module Aws::CognitoIdentityProvider
|
|
6018
6101
|
req.send_request(options)
|
6019
6102
|
end
|
6020
6103
|
|
6021
|
-
# Updates the specified user pool with the specified attributes.
|
6022
|
-
#
|
6023
|
-
#
|
6104
|
+
# Updates the specified user pool with the specified attributes. You can
|
6105
|
+
# get a list of the current user pool settings with .
|
6106
|
+
#
|
6107
|
+
# If you don't provide a value for an attribute, it will be set to the
|
6108
|
+
# default value.
|
6024
6109
|
#
|
6025
6110
|
# @option params [required, String] :user_pool_id
|
6026
6111
|
# The user pool ID for the user pool you want to update.
|
@@ -6166,9 +6251,11 @@ module Aws::CognitoIdentityProvider
|
|
6166
6251
|
end
|
6167
6252
|
|
6168
6253
|
# Updates the specified user pool app client with the specified
|
6169
|
-
# attributes.
|
6170
|
-
#
|
6171
|
-
#
|
6254
|
+
# attributes. You can get a list of the current user pool app client
|
6255
|
+
# settings with .
|
6256
|
+
#
|
6257
|
+
# If you don't provide a value for an attribute, it will be set to the
|
6258
|
+
# default value.
|
6172
6259
|
#
|
6173
6260
|
# @option params [required, String] :user_pool_id
|
6174
6261
|
# The user pool ID for the user pool where you want to update the user
|
@@ -6191,7 +6278,29 @@ module Aws::CognitoIdentityProvider
|
|
6191
6278
|
# The writeable attributes of the user pool.
|
6192
6279
|
#
|
6193
6280
|
# @option params [Array<String>] :explicit_auth_flows
|
6194
|
-
#
|
6281
|
+
# The authentication flows that are supported by the user pool clients.
|
6282
|
+
# Flow names without the `ALLOW_` prefix are deprecated in favor of new
|
6283
|
+
# names with the `ALLOW_` prefix. Note that values with `ALLOW_` prefix
|
6284
|
+
# cannot be used along with values without `ALLOW_` prefix.
|
6285
|
+
#
|
6286
|
+
# Valid values include:
|
6287
|
+
#
|
6288
|
+
# * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user password
|
6289
|
+
# authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting
|
6290
|
+
# replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication
|
6291
|
+
# flow, Cognito receives the password in the request instead of using
|
6292
|
+
# the SRP (Secure Remote Password protocol) protocol to verify
|
6293
|
+
# passwords.
|
6294
|
+
#
|
6295
|
+
# * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
|
6296
|
+
#
|
6297
|
+
# * `ALLOW_USER_PASSWORD_AUTH`\: Enable user password-based
|
6298
|
+
# authentication. In this flow, Cognito receives the password in the
|
6299
|
+
# request instead of using the SRP protocol to verify passwords.
|
6300
|
+
#
|
6301
|
+
# * `ALLOW_USER_SRP_AUTH`\: Enable SRP based authentication.
|
6302
|
+
#
|
6303
|
+
# * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
|
6195
6304
|
#
|
6196
6305
|
# @option params [Array<String>] :supported_identity_providers
|
6197
6306
|
# A list of provider names for the identity providers that are supported
|
@@ -6263,6 +6372,48 @@ module Aws::CognitoIdentityProvider
|
|
6263
6372
|
# The Amazon Pinpoint analytics configuration for collecting metrics for
|
6264
6373
|
# this user pool.
|
6265
6374
|
#
|
6375
|
+
# @option params [String] :prevent_user_existence_errors
|
6376
|
+
# Use this setting to choose which errors and responses are returned by
|
6377
|
+
# Cognito APIs during authentication, account confirmation, and password
|
6378
|
+
# recovery when the user does not exist in the user pool. When set to
|
6379
|
+
# `ENABLED` and the user does not exist, authentication returns an error
|
6380
|
+
# indicating either the username or password was incorrect, and account
|
6381
|
+
# confirmation and password recovery return a response indicating a code
|
6382
|
+
# was sent to a simulated destination. When set to `LEGACY`, those APIs
|
6383
|
+
# will return a `UserNotFoundException` exception if the user does not
|
6384
|
+
# exist in the user pool.
|
6385
|
+
#
|
6386
|
+
# Valid values include:
|
6387
|
+
#
|
6388
|
+
# * `ENABLED` - This prevents user existence-related errors.
|
6389
|
+
#
|
6390
|
+
# * `LEGACY` - This represents the old behavior of Cognito where user
|
6391
|
+
# existence related errors are not prevented.
|
6392
|
+
#
|
6393
|
+
# This setting affects the behavior of following APIs:
|
6394
|
+
#
|
6395
|
+
# * AdminInitiateAuth
|
6396
|
+
#
|
6397
|
+
# * AdminRespondToAuthChallenge
|
6398
|
+
#
|
6399
|
+
# * InitiateAuth
|
6400
|
+
#
|
6401
|
+
# * RespondToAuthChallenge
|
6402
|
+
#
|
6403
|
+
# * ForgotPassword
|
6404
|
+
#
|
6405
|
+
# * ConfirmForgotPassword
|
6406
|
+
#
|
6407
|
+
# * ConfirmSignUp
|
6408
|
+
#
|
6409
|
+
# * ResendConfirmationCode
|
6410
|
+
#
|
6411
|
+
# <note markdown="1"> After January 1st 2020, the value of `PreventUserExistenceErrors` will
|
6412
|
+
# default to `ENABLED` for newly created user pool clients if no value
|
6413
|
+
# is provided.
|
6414
|
+
#
|
6415
|
+
# </note>
|
6416
|
+
#
|
6266
6417
|
# @return [Types::UpdateUserPoolClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6267
6418
|
#
|
6268
6419
|
# * {Types::UpdateUserPoolClientResponse#user_pool_client #user_pool_client} => Types::UserPoolClientType
|
@@ -6276,7 +6427,7 @@ module Aws::CognitoIdentityProvider
|
|
6276
6427
|
# refresh_token_validity: 1,
|
6277
6428
|
# read_attributes: ["ClientPermissionType"],
|
6278
6429
|
# write_attributes: ["ClientPermissionType"],
|
6279
|
-
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH
|
6430
|
+
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH
|
6280
6431
|
# supported_identity_providers: ["ProviderNameType"],
|
6281
6432
|
# callback_urls: ["RedirectUrlType"],
|
6282
6433
|
# logout_urls: ["RedirectUrlType"],
|
@@ -6290,6 +6441,7 @@ module Aws::CognitoIdentityProvider
|
|
6290
6441
|
# external_id: "StringType", # required
|
6291
6442
|
# user_data_shared: false,
|
6292
6443
|
# },
|
6444
|
+
# prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
|
6293
6445
|
# })
|
6294
6446
|
#
|
6295
6447
|
# @example Response structure
|
@@ -6306,7 +6458,7 @@ module Aws::CognitoIdentityProvider
|
|
6306
6458
|
# resp.user_pool_client.write_attributes #=> Array
|
6307
6459
|
# resp.user_pool_client.write_attributes[0] #=> String
|
6308
6460
|
# resp.user_pool_client.explicit_auth_flows #=> Array
|
6309
|
-
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH"
|
6461
|
+
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH"
|
6310
6462
|
# resp.user_pool_client.supported_identity_providers #=> Array
|
6311
6463
|
# resp.user_pool_client.supported_identity_providers[0] #=> String
|
6312
6464
|
# resp.user_pool_client.callback_urls #=> Array
|
@@ -6323,6 +6475,7 @@ module Aws::CognitoIdentityProvider
|
|
6323
6475
|
# resp.user_pool_client.analytics_configuration.role_arn #=> String
|
6324
6476
|
# resp.user_pool_client.analytics_configuration.external_id #=> String
|
6325
6477
|
# resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
|
6478
|
+
# resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
|
6326
6479
|
#
|
6327
6480
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClient AWS API Documentation
|
6328
6481
|
#
|
@@ -6500,7 +6653,7 @@ module Aws::CognitoIdentityProvider
|
|
6500
6653
|
params: params,
|
6501
6654
|
config: config)
|
6502
6655
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
6503
|
-
context[:gem_version] = '1.
|
6656
|
+
context[:gem_version] = '1.28.0'
|
6504
6657
|
Seahorse::Client::Request.new(handlers, context)
|
6505
6658
|
end
|
6506
6659
|
|
@@ -308,6 +308,7 @@ module Aws::CognitoIdentityProvider
|
|
308
308
|
PreSignedUrlType = Shapes::StringShape.new(name: 'PreSignedUrlType')
|
309
309
|
PrecedenceType = Shapes::IntegerShape.new(name: 'PrecedenceType')
|
310
310
|
PreconditionNotMetException = Shapes::StructureShape.new(name: 'PreconditionNotMetException')
|
311
|
+
PreventUserExistenceErrorTypes = Shapes::StringShape.new(name: 'PreventUserExistenceErrorTypes')
|
311
312
|
ProviderDescription = Shapes::StructureShape.new(name: 'ProviderDescription')
|
312
313
|
ProviderDetailsType = Shapes::MapShape.new(name: 'ProviderDetailsType')
|
313
314
|
ProviderNameType = Shapes::StringShape.new(name: 'ProviderNameType')
|
@@ -890,6 +891,7 @@ module Aws::CognitoIdentityProvider
|
|
890
891
|
CreateUserPoolClientRequest.add_member(:allowed_o_auth_scopes, Shapes::ShapeRef.new(shape: ScopeListType, location_name: "AllowedOAuthScopes"))
|
891
892
|
CreateUserPoolClientRequest.add_member(:allowed_o_auth_flows_user_pool_client, Shapes::ShapeRef.new(shape: BooleanType, location_name: "AllowedOAuthFlowsUserPoolClient"))
|
892
893
|
CreateUserPoolClientRequest.add_member(:analytics_configuration, Shapes::ShapeRef.new(shape: AnalyticsConfigurationType, location_name: "AnalyticsConfiguration"))
|
894
|
+
CreateUserPoolClientRequest.add_member(:prevent_user_existence_errors, Shapes::ShapeRef.new(shape: PreventUserExistenceErrorTypes, location_name: "PreventUserExistenceErrors"))
|
893
895
|
CreateUserPoolClientRequest.struct_class = Types::CreateUserPoolClientRequest
|
894
896
|
|
895
897
|
CreateUserPoolClientResponse.add_member(:user_pool_client, Shapes::ShapeRef.new(shape: UserPoolClientType, location_name: "UserPoolClient"))
|
@@ -1694,6 +1696,7 @@ module Aws::CognitoIdentityProvider
|
|
1694
1696
|
UpdateUserPoolClientRequest.add_member(:allowed_o_auth_scopes, Shapes::ShapeRef.new(shape: ScopeListType, location_name: "AllowedOAuthScopes"))
|
1695
1697
|
UpdateUserPoolClientRequest.add_member(:allowed_o_auth_flows_user_pool_client, Shapes::ShapeRef.new(shape: BooleanType, location_name: "AllowedOAuthFlowsUserPoolClient"))
|
1696
1698
|
UpdateUserPoolClientRequest.add_member(:analytics_configuration, Shapes::ShapeRef.new(shape: AnalyticsConfigurationType, location_name: "AnalyticsConfiguration"))
|
1699
|
+
UpdateUserPoolClientRequest.add_member(:prevent_user_existence_errors, Shapes::ShapeRef.new(shape: PreventUserExistenceErrorTypes, location_name: "PreventUserExistenceErrors"))
|
1697
1700
|
UpdateUserPoolClientRequest.struct_class = Types::UpdateUserPoolClientRequest
|
1698
1701
|
|
1699
1702
|
UpdateUserPoolClientResponse.add_member(:user_pool_client, Shapes::ShapeRef.new(shape: UserPoolClientType, location_name: "UserPoolClient"))
|
@@ -1792,6 +1795,7 @@ module Aws::CognitoIdentityProvider
|
|
1792
1795
|
UserPoolClientType.add_member(:allowed_o_auth_scopes, Shapes::ShapeRef.new(shape: ScopeListType, location_name: "AllowedOAuthScopes"))
|
1793
1796
|
UserPoolClientType.add_member(:allowed_o_auth_flows_user_pool_client, Shapes::ShapeRef.new(shape: BooleanType, location_name: "AllowedOAuthFlowsUserPoolClient", metadata: {"box"=>true}))
|
1794
1797
|
UserPoolClientType.add_member(:analytics_configuration, Shapes::ShapeRef.new(shape: AnalyticsConfigurationType, location_name: "AnalyticsConfiguration"))
|
1798
|
+
UserPoolClientType.add_member(:prevent_user_existence_errors, Shapes::ShapeRef.new(shape: PreventUserExistenceErrorTypes, location_name: "PreventUserExistenceErrors"))
|
1795
1799
|
UserPoolClientType.struct_class = Types::UserPoolClientType
|
1796
1800
|
|
1797
1801
|
UserPoolDescriptionType.add_member(:id, Shapes::ShapeRef.new(shape: UserPoolIdType, location_name: "Id"))
|
@@ -916,7 +916,7 @@ module Aws::CognitoIdentityProvider
|
|
916
916
|
# {
|
917
917
|
# user_pool_id: "UserPoolIdType", # required
|
918
918
|
# client_id: "ClientIdType", # required
|
919
|
-
# auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH
|
919
|
+
# auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
|
920
920
|
# auth_parameters: {
|
921
921
|
# "StringType" => "StringType",
|
922
922
|
# },
|
@@ -980,6 +980,12 @@ module Aws::CognitoIdentityProvider
|
|
980
980
|
# PASSWORD are passed directly. If a user migration Lambda trigger
|
981
981
|
# is set, this flow will invoke the user migration Lambda if the
|
982
982
|
# USERNAME is not found in the user pool.
|
983
|
+
#
|
984
|
+
# * `ADMIN_USER_PASSWORD_AUTH`\: Admin-based user password
|
985
|
+
# authentication. This replaces the `ADMIN_NO_SRP_AUTH`
|
986
|
+
# authentication flow. In this flow, Cognito receives the password
|
987
|
+
# in the request instead of using the SRP process to verify
|
988
|
+
# passwords.
|
983
989
|
# @return [String]
|
984
990
|
#
|
985
991
|
# @!attribute [rw] auth_parameters
|
@@ -2584,15 +2590,14 @@ module Aws::CognitoIdentityProvider
|
|
2584
2590
|
#
|
2585
2591
|
# You create custom workflows by assigning AWS Lambda functions to
|
2586
2592
|
# user pool triggers. When you use the ConfirmForgotPassword API
|
2587
|
-
# action, Amazon Cognito invokes the
|
2588
|
-
#
|
2589
|
-
#
|
2590
|
-
#
|
2591
|
-
#
|
2592
|
-
#
|
2593
|
-
#
|
2594
|
-
#
|
2595
|
-
# for your specific needs.
|
2593
|
+
# action, Amazon Cognito invokes the function that is assigned to the
|
2594
|
+
# *post confirmation* trigger. When Amazon Cognito invokes this
|
2595
|
+
# function, it passes a JSON payload, which the function receives as
|
2596
|
+
# input. This payload contains a `clientMetadata` attribute, which
|
2597
|
+
# provides the data that you assigned to the ClientMetadata parameter
|
2598
|
+
# in your ConfirmForgotPassword request. In your function code in AWS
|
2599
|
+
# Lambda, you can process the `clientMetadata` value to enhance your
|
2600
|
+
# workflow for your specific needs.
|
2596
2601
|
#
|
2597
2602
|
# For more information, see [Customizing User Pool Workflows with
|
2598
2603
|
# Lambda Triggers][1] in the *Amazon Cognito Developer Guide*.
|
@@ -3061,7 +3066,7 @@ module Aws::CognitoIdentityProvider
|
|
3061
3066
|
# refresh_token_validity: 1,
|
3062
3067
|
# read_attributes: ["ClientPermissionType"],
|
3063
3068
|
# write_attributes: ["ClientPermissionType"],
|
3064
|
-
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH
|
3069
|
+
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH
|
3065
3070
|
# supported_identity_providers: ["ProviderNameType"],
|
3066
3071
|
# callback_urls: ["RedirectUrlType"],
|
3067
3072
|
# logout_urls: ["RedirectUrlType"],
|
@@ -3075,6 +3080,7 @@ module Aws::CognitoIdentityProvider
|
|
3075
3080
|
# external_id: "StringType", # required
|
3076
3081
|
# user_data_shared: false,
|
3077
3082
|
# },
|
3083
|
+
# prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
|
3078
3084
|
# }
|
3079
3085
|
#
|
3080
3086
|
# @!attribute [rw] user_pool_id
|
@@ -3118,7 +3124,30 @@ module Aws::CognitoIdentityProvider
|
|
3118
3124
|
# @return [Array<String>]
|
3119
3125
|
#
|
3120
3126
|
# @!attribute [rw] explicit_auth_flows
|
3121
|
-
# The
|
3127
|
+
# The authentication flows that are supported by the user pool
|
3128
|
+
# clients. Flow names without the `ALLOW_` prefix are deprecated in
|
3129
|
+
# favor of new names with the `ALLOW_` prefix. Note that values with
|
3130
|
+
# `ALLOW_` prefix cannot be used along with values without `ALLOW_`
|
3131
|
+
# prefix.
|
3132
|
+
#
|
3133
|
+
# Valid values include:
|
3134
|
+
#
|
3135
|
+
# * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user
|
3136
|
+
# password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This
|
3137
|
+
# setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this
|
3138
|
+
# authentication flow, Cognito receives the password in the request
|
3139
|
+
# instead of using the SRP (Secure Remote Password protocol)
|
3140
|
+
# protocol to verify passwords.
|
3141
|
+
#
|
3142
|
+
# * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
|
3143
|
+
#
|
3144
|
+
# * `ALLOW_USER_PASSWORD_AUTH`\: Enable user password-based
|
3145
|
+
# authentication. In this flow, Cognito receives the password in the
|
3146
|
+
# request instead of using the SRP protocol to verify passwords.
|
3147
|
+
#
|
3148
|
+
# * `ALLOW_USER_SRP_AUTH`\: Enable SRP based authentication.
|
3149
|
+
#
|
3150
|
+
# * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
|
3122
3151
|
# @return [Array<String>]
|
3123
3152
|
#
|
3124
3153
|
# @!attribute [rw] supported_identity_providers
|
@@ -3204,6 +3233,49 @@ module Aws::CognitoIdentityProvider
|
|
3204
3233
|
# for this user pool.
|
3205
3234
|
# @return [Types::AnalyticsConfigurationType]
|
3206
3235
|
#
|
3236
|
+
# @!attribute [rw] prevent_user_existence_errors
|
3237
|
+
# Use this setting to choose which errors and responses are returned
|
3238
|
+
# by Cognito APIs during authentication, account confirmation, and
|
3239
|
+
# password recovery when the user does not exist in the user pool.
|
3240
|
+
# When set to `ENABLED` and the user does not exist, authentication
|
3241
|
+
# returns an error indicating either the username or password was
|
3242
|
+
# incorrect, and account confirmation and password recovery return a
|
3243
|
+
# response indicating a code was sent to a simulated destination. When
|
3244
|
+
# set to `LEGACY`, those APIs will return a `UserNotFoundException`
|
3245
|
+
# exception if the user does not exist in the user pool.
|
3246
|
+
#
|
3247
|
+
# Valid values include:
|
3248
|
+
#
|
3249
|
+
# * `ENABLED` - This prevents user existence-related errors.
|
3250
|
+
#
|
3251
|
+
# * `LEGACY` - This represents the old behavior of Cognito where user
|
3252
|
+
# existence related errors are not prevented.
|
3253
|
+
#
|
3254
|
+
# This setting affects the behavior of following APIs:
|
3255
|
+
#
|
3256
|
+
# * AdminInitiateAuth
|
3257
|
+
#
|
3258
|
+
# * AdminRespondToAuthChallenge
|
3259
|
+
#
|
3260
|
+
# * InitiateAuth
|
3261
|
+
#
|
3262
|
+
# * RespondToAuthChallenge
|
3263
|
+
#
|
3264
|
+
# * ForgotPassword
|
3265
|
+
#
|
3266
|
+
# * ConfirmForgotPassword
|
3267
|
+
#
|
3268
|
+
# * ConfirmSignUp
|
3269
|
+
#
|
3270
|
+
# * ResendConfirmationCode
|
3271
|
+
#
|
3272
|
+
# <note markdown="1"> After January 1st 2020, the value of `PreventUserExistenceErrors`
|
3273
|
+
# will default to `ENABLED` for newly created user pool clients if no
|
3274
|
+
# value is provided.
|
3275
|
+
#
|
3276
|
+
# </note>
|
3277
|
+
# @return [String]
|
3278
|
+
#
|
3207
3279
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClientRequest AWS API Documentation
|
3208
3280
|
#
|
3209
3281
|
class CreateUserPoolClientRequest < Struct.new(
|
@@ -3221,7 +3293,8 @@ module Aws::CognitoIdentityProvider
|
|
3221
3293
|
:allowed_o_auth_flows,
|
3222
3294
|
:allowed_o_auth_scopes,
|
3223
3295
|
:allowed_o_auth_flows_user_pool_client,
|
3224
|
-
:analytics_configuration
|
3296
|
+
:analytics_configuration,
|
3297
|
+
:prevent_user_existence_errors)
|
3225
3298
|
include Aws::Structure
|
3226
3299
|
end
|
3227
3300
|
|
@@ -5077,7 +5150,7 @@ module Aws::CognitoIdentityProvider
|
|
5077
5150
|
# data as a hash:
|
5078
5151
|
#
|
5079
5152
|
# {
|
5080
|
-
# auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH
|
5153
|
+
# auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
|
5081
5154
|
# auth_parameters: {
|
5082
5155
|
# "StringType" => "StringType",
|
5083
5156
|
# },
|
@@ -5122,6 +5195,12 @@ module Aws::CognitoIdentityProvider
|
|
5122
5195
|
# is set, this flow will invoke the user migration Lambda if the
|
5123
5196
|
# USERNAME is not found in the user pool.
|
5124
5197
|
#
|
5198
|
+
# * `ADMIN_USER_PASSWORD_AUTH`\: Admin-based user password
|
5199
|
+
# authentication. This replaces the `ADMIN_NO_SRP_AUTH`
|
5200
|
+
# authentication flow. In this flow, Cognito receives the password
|
5201
|
+
# in the request instead of using the SRP process to verify
|
5202
|
+
# passwords.
|
5203
|
+
#
|
5125
5204
|
# `ADMIN_NO_SRP_AUTH` is not a valid value.
|
5126
5205
|
# @return [String]
|
5127
5206
|
#
|
@@ -8171,12 +8250,11 @@ module Aws::CognitoIdentityProvider
|
|
8171
8250
|
#
|
8172
8251
|
# You create custom workflows by assigning AWS Lambda functions to
|
8173
8252
|
# user pool triggers. When you use the UpdateUserAttributes API
|
8174
|
-
# action, Amazon Cognito invokes the
|
8175
|
-
#
|
8176
|
-
#
|
8177
|
-
#
|
8178
|
-
#
|
8179
|
-
# assigned to the ClientMetadata parameter in your
|
8253
|
+
# action, Amazon Cognito invokes the function that is assigned to the
|
8254
|
+
# *custom message* trigger. When Amazon Cognito invokes this function,
|
8255
|
+
# it passes a JSON payload, which the function receives as input. This
|
8256
|
+
# payload contains a `clientMetadata` attribute, which provides the
|
8257
|
+
# data that you assigned to the ClientMetadata parameter in your
|
8180
8258
|
# UpdateUserAttributes request. In your function code in AWS Lambda,
|
8181
8259
|
# you can process the `clientMetadata` value to enhance your workflow
|
8182
8260
|
# for your specific needs.
|
@@ -8241,7 +8319,7 @@ module Aws::CognitoIdentityProvider
|
|
8241
8319
|
# refresh_token_validity: 1,
|
8242
8320
|
# read_attributes: ["ClientPermissionType"],
|
8243
8321
|
# write_attributes: ["ClientPermissionType"],
|
8244
|
-
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH
|
8322
|
+
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH
|
8245
8323
|
# supported_identity_providers: ["ProviderNameType"],
|
8246
8324
|
# callback_urls: ["RedirectUrlType"],
|
8247
8325
|
# logout_urls: ["RedirectUrlType"],
|
@@ -8255,6 +8333,7 @@ module Aws::CognitoIdentityProvider
|
|
8255
8333
|
# external_id: "StringType", # required
|
8256
8334
|
# user_data_shared: false,
|
8257
8335
|
# },
|
8336
|
+
# prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
|
8258
8337
|
# }
|
8259
8338
|
#
|
8260
8339
|
# @!attribute [rw] user_pool_id
|
@@ -8284,7 +8363,30 @@ module Aws::CognitoIdentityProvider
|
|
8284
8363
|
# @return [Array<String>]
|
8285
8364
|
#
|
8286
8365
|
# @!attribute [rw] explicit_auth_flows
|
8287
|
-
#
|
8366
|
+
# The authentication flows that are supported by the user pool
|
8367
|
+
# clients. Flow names without the `ALLOW_` prefix are deprecated in
|
8368
|
+
# favor of new names with the `ALLOW_` prefix. Note that values with
|
8369
|
+
# `ALLOW_` prefix cannot be used along with values without `ALLOW_`
|
8370
|
+
# prefix.
|
8371
|
+
#
|
8372
|
+
# Valid values include:
|
8373
|
+
#
|
8374
|
+
# * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user
|
8375
|
+
# password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This
|
8376
|
+
# setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this
|
8377
|
+
# authentication flow, Cognito receives the password in the request
|
8378
|
+
# instead of using the SRP (Secure Remote Password protocol)
|
8379
|
+
# protocol to verify passwords.
|
8380
|
+
#
|
8381
|
+
# * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
|
8382
|
+
#
|
8383
|
+
# * `ALLOW_USER_PASSWORD_AUTH`\: Enable user password-based
|
8384
|
+
# authentication. In this flow, Cognito receives the password in the
|
8385
|
+
# request instead of using the SRP protocol to verify passwords.
|
8386
|
+
#
|
8387
|
+
# * `ALLOW_USER_SRP_AUTH`\: Enable SRP based authentication.
|
8388
|
+
#
|
8389
|
+
# * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
|
8288
8390
|
# @return [Array<String>]
|
8289
8391
|
#
|
8290
8392
|
# @!attribute [rw] supported_identity_providers
|
@@ -8366,6 +8468,49 @@ module Aws::CognitoIdentityProvider
|
|
8366
8468
|
# for this user pool.
|
8367
8469
|
# @return [Types::AnalyticsConfigurationType]
|
8368
8470
|
#
|
8471
|
+
# @!attribute [rw] prevent_user_existence_errors
|
8472
|
+
# Use this setting to choose which errors and responses are returned
|
8473
|
+
# by Cognito APIs during authentication, account confirmation, and
|
8474
|
+
# password recovery when the user does not exist in the user pool.
|
8475
|
+
# When set to `ENABLED` and the user does not exist, authentication
|
8476
|
+
# returns an error indicating either the username or password was
|
8477
|
+
# incorrect, and account confirmation and password recovery return a
|
8478
|
+
# response indicating a code was sent to a simulated destination. When
|
8479
|
+
# set to `LEGACY`, those APIs will return a `UserNotFoundException`
|
8480
|
+
# exception if the user does not exist in the user pool.
|
8481
|
+
#
|
8482
|
+
# Valid values include:
|
8483
|
+
#
|
8484
|
+
# * `ENABLED` - This prevents user existence-related errors.
|
8485
|
+
#
|
8486
|
+
# * `LEGACY` - This represents the old behavior of Cognito where user
|
8487
|
+
# existence related errors are not prevented.
|
8488
|
+
#
|
8489
|
+
# This setting affects the behavior of following APIs:
|
8490
|
+
#
|
8491
|
+
# * AdminInitiateAuth
|
8492
|
+
#
|
8493
|
+
# * AdminRespondToAuthChallenge
|
8494
|
+
#
|
8495
|
+
# * InitiateAuth
|
8496
|
+
#
|
8497
|
+
# * RespondToAuthChallenge
|
8498
|
+
#
|
8499
|
+
# * ForgotPassword
|
8500
|
+
#
|
8501
|
+
# * ConfirmForgotPassword
|
8502
|
+
#
|
8503
|
+
# * ConfirmSignUp
|
8504
|
+
#
|
8505
|
+
# * ResendConfirmationCode
|
8506
|
+
#
|
8507
|
+
# <note markdown="1"> After January 1st 2020, the value of `PreventUserExistenceErrors`
|
8508
|
+
# will default to `ENABLED` for newly created user pool clients if no
|
8509
|
+
# value is provided.
|
8510
|
+
#
|
8511
|
+
# </note>
|
8512
|
+
# @return [String]
|
8513
|
+
#
|
8369
8514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClientRequest AWS API Documentation
|
8370
8515
|
#
|
8371
8516
|
class UpdateUserPoolClientRequest < Struct.new(
|
@@ -8383,7 +8528,8 @@ module Aws::CognitoIdentityProvider
|
|
8383
8528
|
:allowed_o_auth_flows,
|
8384
8529
|
:allowed_o_auth_scopes,
|
8385
8530
|
:allowed_o_auth_flows_user_pool_client,
|
8386
|
-
:analytics_configuration
|
8531
|
+
:analytics_configuration,
|
8532
|
+
:prevent_user_existence_errors)
|
8387
8533
|
include Aws::Structure
|
8388
8534
|
end
|
8389
8535
|
|
@@ -8910,7 +9056,30 @@ module Aws::CognitoIdentityProvider
|
|
8910
9056
|
# @return [Array<String>]
|
8911
9057
|
#
|
8912
9058
|
# @!attribute [rw] explicit_auth_flows
|
8913
|
-
# The
|
9059
|
+
# The authentication flows that are supported by the user pool
|
9060
|
+
# clients. Flow names without the `ALLOW_` prefix are deprecated in
|
9061
|
+
# favor of new names with the `ALLOW_` prefix. Note that values with
|
9062
|
+
# `ALLOW_` prefix cannot be used along with values without `ALLOW_`
|
9063
|
+
# prefix.
|
9064
|
+
#
|
9065
|
+
# Valid values include:
|
9066
|
+
#
|
9067
|
+
# * `ALLOW_ADMIN_USER_PASSWORD_AUTH`\: Enable admin based user
|
9068
|
+
# password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This
|
9069
|
+
# setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this
|
9070
|
+
# authentication flow, Cognito receives the password in the request
|
9071
|
+
# instead of using the SRP (Secure Remote Password protocol)
|
9072
|
+
# protocol to verify passwords.
|
9073
|
+
#
|
9074
|
+
# * `ALLOW_CUSTOM_AUTH`\: Enable Lambda trigger based authentication.
|
9075
|
+
#
|
9076
|
+
# * `ALLOW_USER_PASSWORD_AUTH`\: Enable user password-based
|
9077
|
+
# authentication. In this flow, Cognito receives the password in the
|
9078
|
+
# request instead of using the SRP protocol to verify passwords.
|
9079
|
+
#
|
9080
|
+
# * `ALLOW_USER_SRP_AUTH`\: Enable SRP based authentication.
|
9081
|
+
#
|
9082
|
+
# * `ALLOW_REFRESH_TOKEN_AUTH`\: Enable authflow to refresh tokens.
|
8914
9083
|
# @return [Array<String>]
|
8915
9084
|
#
|
8916
9085
|
# @!attribute [rw] supported_identity_providers
|
@@ -8995,6 +9164,49 @@ module Aws::CognitoIdentityProvider
|
|
8995
9164
|
# client.
|
8996
9165
|
# @return [Types::AnalyticsConfigurationType]
|
8997
9166
|
#
|
9167
|
+
# @!attribute [rw] prevent_user_existence_errors
|
9168
|
+
# Use this setting to choose which errors and responses are returned
|
9169
|
+
# by Cognito APIs during authentication, account confirmation, and
|
9170
|
+
# password recovery when the user does not exist in the user pool.
|
9171
|
+
# When set to `ENABLED` and the user does not exist, authentication
|
9172
|
+
# returns an error indicating either the username or password was
|
9173
|
+
# incorrect, and account confirmation and password recovery return a
|
9174
|
+
# response indicating a code was sent to a simulated destination. When
|
9175
|
+
# set to `LEGACY`, those APIs will return a `UserNotFoundException`
|
9176
|
+
# exception if the user does not exist in the user pool.
|
9177
|
+
#
|
9178
|
+
# Valid values include:
|
9179
|
+
#
|
9180
|
+
# * `ENABLED` - This prevents user existence-related errors.
|
9181
|
+
#
|
9182
|
+
# * `LEGACY` - This represents the old behavior of Cognito where user
|
9183
|
+
# existence related errors are not prevented.
|
9184
|
+
#
|
9185
|
+
# This setting affects the behavior of following APIs:
|
9186
|
+
#
|
9187
|
+
# * AdminInitiateAuth
|
9188
|
+
#
|
9189
|
+
# * AdminRespondToAuthChallenge
|
9190
|
+
#
|
9191
|
+
# * InitiateAuth
|
9192
|
+
#
|
9193
|
+
# * RespondToAuthChallenge
|
9194
|
+
#
|
9195
|
+
# * ForgotPassword
|
9196
|
+
#
|
9197
|
+
# * ConfirmForgotPassword
|
9198
|
+
#
|
9199
|
+
# * ConfirmSignUp
|
9200
|
+
#
|
9201
|
+
# * ResendConfirmationCode
|
9202
|
+
#
|
9203
|
+
# <note markdown="1"> After January 1st 2020, the value of `PreventUserExistenceErrors`
|
9204
|
+
# will default to `ENABLED` for newly created user pool clients if no
|
9205
|
+
# value is provided.
|
9206
|
+
#
|
9207
|
+
# </note>
|
9208
|
+
# @return [String]
|
9209
|
+
#
|
8998
9210
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolClientType AWS API Documentation
|
8999
9211
|
#
|
9000
9212
|
class UserPoolClientType < Struct.new(
|
@@ -9015,7 +9227,8 @@ module Aws::CognitoIdentityProvider
|
|
9015
9227
|
:allowed_o_auth_flows,
|
9016
9228
|
:allowed_o_auth_scopes,
|
9017
9229
|
:allowed_o_auth_flows_user_pool_client,
|
9018
|
-
:analytics_configuration
|
9230
|
+
:analytics_configuration,
|
9231
|
+
:prevent_user_existence_errors)
|
9019
9232
|
include Aws::Structure
|
9020
9233
|
end
|
9021
9234
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cognitoidentityprovider
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.28.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-11-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|