aws-sdk-cognitoidentityprovider 1.31.0 → 1.32.0
Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7361662f5b0bb67d92023891586c6754bcd59a79
|
4
|
+
data.tar.gz: 0ec4d5ed41aa58bb88d9f421ffdc8b76c454e08f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3e52d8c2d325203792364482f6d14c3a011857f2185256cae3dd4a59cbc0ae816ba50bb8fa1cedb75dac824af8dc005edca238eb7104f4e52a230dfc394c5bb7
|
7
|
+
data.tar.gz: d826e8ee58e58d4626c3586e48d85b71f23b5edf6ac7f562e4342917d95674699dd3376c50d3b4a328752aa41de6c3184a8e7d5729cacf9212dbcd74107f3e3d
|
@@ -1086,7 +1086,7 @@ module Aws::CognitoIdentityProvider
|
|
1086
1086
|
# client_id: "ClientIdType", # required
|
1087
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
|
1088
1088
|
# auth_parameters: {
|
1089
|
-
# "StringType" => "
|
1089
|
+
# "StringType" => "AuthParametersValueType",
|
1090
1090
|
# },
|
1091
1091
|
# client_metadata: {
|
1092
1092
|
# "StringType" => "StringType",
|
@@ -2380,8 +2380,60 @@ module Aws::CognitoIdentityProvider
|
|
2380
2380
|
# The identity provider type.
|
2381
2381
|
#
|
2382
2382
|
# @option params [required, Hash<String,String>] :provider_details
|
2383
|
-
# The identity provider details
|
2384
|
-
#
|
2383
|
+
# The identity provider details. The following list describes the
|
2384
|
+
# provider detail keys for each identity provider type.
|
2385
|
+
#
|
2386
|
+
# * For Google, Facebook and Login with Amazon:
|
2387
|
+
#
|
2388
|
+
# * client\_id
|
2389
|
+
#
|
2390
|
+
# * client\_secret
|
2391
|
+
#
|
2392
|
+
# * authorize\_scopes
|
2393
|
+
#
|
2394
|
+
# * For Sign in with Apple:
|
2395
|
+
#
|
2396
|
+
# * client\_id
|
2397
|
+
#
|
2398
|
+
# * team\_id
|
2399
|
+
#
|
2400
|
+
# * key\_id
|
2401
|
+
#
|
2402
|
+
# * private\_key
|
2403
|
+
#
|
2404
|
+
# * authorize\_scopes
|
2405
|
+
#
|
2406
|
+
# * For OIDC providers:
|
2407
|
+
#
|
2408
|
+
# * client\_id
|
2409
|
+
#
|
2410
|
+
# * client\_secret
|
2411
|
+
#
|
2412
|
+
# * attributes\_request\_method
|
2413
|
+
#
|
2414
|
+
# * oidc\_issuer
|
2415
|
+
#
|
2416
|
+
# * authorize\_scopes
|
2417
|
+
#
|
2418
|
+
# * authorize\_url *if not available from discovery URL specified by
|
2419
|
+
# oidc\_issuer key*
|
2420
|
+
#
|
2421
|
+
# * token\_url *if not available from discovery URL specified by
|
2422
|
+
# oidc\_issuer key*
|
2423
|
+
#
|
2424
|
+
# * attributes\_url *if not available from discovery URL specified by
|
2425
|
+
# oidc\_issuer key*
|
2426
|
+
#
|
2427
|
+
# * jwks\_uri *if not available from discovery URL specified by
|
2428
|
+
# oidc\_issuer key*
|
2429
|
+
#
|
2430
|
+
# * authorize\_scopes
|
2431
|
+
#
|
2432
|
+
# * For SAML providers:
|
2433
|
+
#
|
2434
|
+
# * MetadataFile OR MetadataURL
|
2435
|
+
#
|
2436
|
+
# * IDPSignOut *optional*
|
2385
2437
|
#
|
2386
2438
|
# @option params [Hash<String,String>] :attribute_mapping
|
2387
2439
|
# A mapping of identity provider attributes to standard and custom user
|
@@ -2623,6 +2675,13 @@ module Aws::CognitoIdentityProvider
|
|
2623
2675
|
# Used to enable advanced security risk detection. Set the key
|
2624
2676
|
# `AdvancedSecurityMode` to the value "AUDIT".
|
2625
2677
|
#
|
2678
|
+
# @option params [Types::UsernameConfigurationType] :username_configuration
|
2679
|
+
# You can choose to set case sensitivity on the username input for the
|
2680
|
+
# selected sign-in option. For example, when this is set to `False`,
|
2681
|
+
# users will be able to sign in using either "username" or
|
2682
|
+
# "Username". This configuration is immutable once it has been set.
|
2683
|
+
# For more information, see .
|
2684
|
+
#
|
2626
2685
|
# @option params [Types::AccountRecoverySettingType] :account_recovery_setting
|
2627
2686
|
# Use this setting to define which verified available method a user can
|
2628
2687
|
# use to recover their password when they call `ForgotPassword`. It
|
@@ -2731,6 +2790,9 @@ module Aws::CognitoIdentityProvider
|
|
2731
2790
|
# user_pool_add_ons: {
|
2732
2791
|
# advanced_security_mode: "OFF", # required, accepts OFF, AUDIT, ENFORCED
|
2733
2792
|
# },
|
2793
|
+
# username_configuration: {
|
2794
|
+
# case_sensitive: false, # required
|
2795
|
+
# },
|
2734
2796
|
# account_recovery_setting: {
|
2735
2797
|
# recovery_mechanisms: [
|
2736
2798
|
# {
|
@@ -2813,6 +2875,7 @@ module Aws::CognitoIdentityProvider
|
|
2813
2875
|
# resp.user_pool.admin_create_user_config.invite_message_template.email_message #=> String
|
2814
2876
|
# resp.user_pool.admin_create_user_config.invite_message_template.email_subject #=> String
|
2815
2877
|
# resp.user_pool.user_pool_add_ons.advanced_security_mode #=> String, one of "OFF", "AUDIT", "ENFORCED"
|
2878
|
+
# resp.user_pool.username_configuration.case_sensitive #=> Boolean
|
2816
2879
|
# resp.user_pool.arn #=> String
|
2817
2880
|
# resp.user_pool.account_recovery_setting.recovery_mechanisms #=> Array
|
2818
2881
|
# resp.user_pool.account_recovery_setting.recovery_mechanisms[0].priority #=> Integer
|
@@ -2941,22 +3004,28 @@ module Aws::CognitoIdentityProvider
|
|
2941
3004
|
# [1]: https://tools.ietf.org/html/rfc6749#section-3.1.2
|
2942
3005
|
#
|
2943
3006
|
# @option params [Array<String>] :allowed_o_auth_flows
|
3007
|
+
# The allowed OAuth flows.
|
3008
|
+
#
|
2944
3009
|
# Set to `code` to initiate a code grant flow, which provides an
|
2945
3010
|
# authorization code as the response. This code can be exchanged for
|
2946
3011
|
# access tokens with the token endpoint.
|
2947
3012
|
#
|
2948
|
-
# Set to `
|
2949
|
-
# (and, optionally, ID token, based on scopes) directly.
|
3013
|
+
# Set to `implicit` to specify that the client should get the access
|
3014
|
+
# token (and, optionally, ID token, based on scopes) directly.
|
3015
|
+
#
|
3016
|
+
# Set to `client_credentials` to specify that the client should get the
|
3017
|
+
# access token (and, optionally, ID token, based on scopes) from the
|
3018
|
+
# token endpoint using a combination of client and client\_secret.
|
2950
3019
|
#
|
2951
3020
|
# @option params [Array<String>] :allowed_o_auth_scopes
|
2952
|
-
#
|
2953
|
-
# `
|
2954
|
-
#
|
2955
|
-
# supported.
|
3021
|
+
# The allowed OAuth scopes. Possible values provided by OAuth are:
|
3022
|
+
# `phone`, `email`, `openid`, and `profile`. Possible values provided by
|
3023
|
+
# AWS are: `aws.cognito.signin.user.admin`. Custom scopes created in
|
3024
|
+
# Resource Servers are also supported.
|
2956
3025
|
#
|
2957
3026
|
# @option params [Boolean] :allowed_o_auth_flows_user_pool_client
|
2958
|
-
# Set to
|
2959
|
-
#
|
3027
|
+
# Set to true if the client is allowed to follow the OAuth protocol when
|
3028
|
+
# interacting with Cognito user pools.
|
2960
3029
|
#
|
2961
3030
|
# @option params [Types::AnalyticsConfigurationType] :analytics_configuration
|
2962
3031
|
# The Amazon Pinpoint analytics configuration for collecting metrics for
|
@@ -2998,9 +3067,9 @@ module Aws::CognitoIdentityProvider
|
|
2998
3067
|
#
|
2999
3068
|
# * ResendConfirmationCode
|
3000
3069
|
#
|
3001
|
-
# <note markdown="1"> After
|
3002
|
-
# default to `ENABLED` for newly created user pool clients if no
|
3003
|
-
# is provided.
|
3070
|
+
# <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
|
3071
|
+
# will default to `ENABLED` for newly created user pool clients if no
|
3072
|
+
# value is provided.
|
3004
3073
|
#
|
3005
3074
|
# </note>
|
3006
3075
|
#
|
@@ -3604,6 +3673,7 @@ module Aws::CognitoIdentityProvider
|
|
3604
3673
|
# resp.user_pool.admin_create_user_config.invite_message_template.email_message #=> String
|
3605
3674
|
# resp.user_pool.admin_create_user_config.invite_message_template.email_subject #=> String
|
3606
3675
|
# resp.user_pool.user_pool_add_ons.advanced_security_mode #=> String, one of "OFF", "AUDIT", "ENFORCED"
|
3676
|
+
# resp.user_pool.username_configuration.case_sensitive #=> Boolean
|
3607
3677
|
# resp.user_pool.arn #=> String
|
3608
3678
|
# resp.user_pool.account_recovery_setting.recovery_mechanisms #=> Array
|
3609
3679
|
# resp.user_pool.account_recovery_setting.recovery_mechanisms[0].priority #=> Integer
|
@@ -4389,7 +4459,7 @@ module Aws::CognitoIdentityProvider
|
|
4389
4459
|
# resp = client.initiate_auth({
|
4390
4460
|
# 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
|
4391
4461
|
# auth_parameters: {
|
4392
|
-
# "StringType" => "
|
4462
|
+
# "StringType" => "AuthParametersValueType",
|
4393
4463
|
# },
|
4394
4464
|
# client_metadata: {
|
4395
4465
|
# "StringType" => "StringType",
|
@@ -6414,18 +6484,27 @@ module Aws::CognitoIdentityProvider
|
|
6414
6484
|
# [1]: https://tools.ietf.org/html/rfc6749#section-3.1.2
|
6415
6485
|
#
|
6416
6486
|
# @option params [Array<String>] :allowed_o_auth_flows
|
6487
|
+
# The allowed OAuth flows.
|
6488
|
+
#
|
6417
6489
|
# Set to `code` to initiate a code grant flow, which provides an
|
6418
6490
|
# authorization code as the response. This code can be exchanged for
|
6419
6491
|
# access tokens with the token endpoint.
|
6420
6492
|
#
|
6493
|
+
# Set to `implicit` to specify that the client should get the access
|
6494
|
+
# token (and, optionally, ID token, based on scopes) directly.
|
6495
|
+
#
|
6496
|
+
# Set to `client_credentials` to specify that the client should get the
|
6497
|
+
# access token (and, optionally, ID token, based on scopes) from the
|
6498
|
+
# token endpoint using a combination of client and client\_secret.
|
6499
|
+
#
|
6421
6500
|
# @option params [Array<String>] :allowed_o_auth_scopes
|
6422
|
-
#
|
6423
|
-
# `
|
6424
|
-
#
|
6425
|
-
# supported.
|
6501
|
+
# The allowed OAuth scopes. Possible values provided by OAuth are:
|
6502
|
+
# `phone`, `email`, `openid`, and `profile`. Possible values provided by
|
6503
|
+
# AWS are: `aws.cognito.signin.user.admin`. Custom scopes created in
|
6504
|
+
# Resource Servers are also supported.
|
6426
6505
|
#
|
6427
6506
|
# @option params [Boolean] :allowed_o_auth_flows_user_pool_client
|
6428
|
-
# Set to
|
6507
|
+
# Set to true if the client is allowed to follow the OAuth protocol when
|
6429
6508
|
# interacting with Cognito user pools.
|
6430
6509
|
#
|
6431
6510
|
# @option params [Types::AnalyticsConfigurationType] :analytics_configuration
|
@@ -6468,9 +6547,9 @@ module Aws::CognitoIdentityProvider
|
|
6468
6547
|
#
|
6469
6548
|
# * ResendConfirmationCode
|
6470
6549
|
#
|
6471
|
-
# <note markdown="1"> After
|
6472
|
-
# default to `ENABLED` for newly created user pool clients if no
|
6473
|
-
# is provided.
|
6550
|
+
# <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
|
6551
|
+
# will default to `ENABLED` for newly created user pool clients if no
|
6552
|
+
# value is provided.
|
6474
6553
|
#
|
6475
6554
|
# </note>
|
6476
6555
|
#
|
@@ -6713,7 +6792,7 @@ module Aws::CognitoIdentityProvider
|
|
6713
6792
|
params: params,
|
6714
6793
|
config: config)
|
6715
6794
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
6716
|
-
context[:gem_version] = '1.
|
6795
|
+
context[:gem_version] = '1.32.0'
|
6717
6796
|
Seahorse::Client::Request.new(handlers, context)
|
6718
6797
|
end
|
6719
6798
|
|
@@ -91,6 +91,7 @@ module Aws::CognitoIdentityProvider
|
|
91
91
|
AuthEventsType = Shapes::ListShape.new(name: 'AuthEventsType')
|
92
92
|
AuthFlowType = Shapes::StringShape.new(name: 'AuthFlowType')
|
93
93
|
AuthParametersType = Shapes::MapShape.new(name: 'AuthParametersType')
|
94
|
+
AuthParametersValueType = Shapes::StringShape.new(name: 'AuthParametersValueType')
|
94
95
|
AuthenticationResultType = Shapes::StructureShape.new(name: 'AuthenticationResultType')
|
95
96
|
BlockedIPRangeListType = Shapes::ListShape.new(name: 'BlockedIPRangeListType')
|
96
97
|
BooleanType = Shapes::BooleanShape.new(name: 'BooleanType')
|
@@ -445,6 +446,7 @@ module Aws::CognitoIdentityProvider
|
|
445
446
|
UserType = Shapes::StructureShape.new(name: 'UserType')
|
446
447
|
UsernameAttributeType = Shapes::StringShape.new(name: 'UsernameAttributeType')
|
447
448
|
UsernameAttributesListType = Shapes::ListShape.new(name: 'UsernameAttributesListType')
|
449
|
+
UsernameConfigurationType = Shapes::StructureShape.new(name: 'UsernameConfigurationType')
|
448
450
|
UsernameExistsException = Shapes::StructureShape.new(name: 'UsernameExistsException')
|
449
451
|
UsernameType = Shapes::StringShape.new(name: 'UsernameType')
|
450
452
|
UsersListType = Shapes::ListShape.new(name: 'UsersListType')
|
@@ -456,6 +458,7 @@ module Aws::CognitoIdentityProvider
|
|
456
458
|
VerifySoftwareTokenResponseType = Shapes::StringShape.new(name: 'VerifySoftwareTokenResponseType')
|
457
459
|
VerifyUserAttributeRequest = Shapes::StructureShape.new(name: 'VerifyUserAttributeRequest')
|
458
460
|
VerifyUserAttributeResponse = Shapes::StructureShape.new(name: 'VerifyUserAttributeResponse')
|
461
|
+
WrappedBooleanType = Shapes::BooleanShape.new(name: 'WrappedBooleanType')
|
459
462
|
|
460
463
|
AccountRecoverySettingType.add_member(:recovery_mechanisms, Shapes::ShapeRef.new(shape: RecoveryMechanismsType, location_name: "RecoveryMechanisms"))
|
461
464
|
AccountRecoverySettingType.struct_class = Types::AccountRecoverySettingType
|
@@ -746,7 +749,7 @@ module Aws::CognitoIdentityProvider
|
|
746
749
|
AuthEventsType.member = Shapes::ShapeRef.new(shape: AuthEventType)
|
747
750
|
|
748
751
|
AuthParametersType.key = Shapes::ShapeRef.new(shape: StringType)
|
749
|
-
AuthParametersType.value = Shapes::ShapeRef.new(shape:
|
752
|
+
AuthParametersType.value = Shapes::ShapeRef.new(shape: AuthParametersValueType)
|
750
753
|
|
751
754
|
AuthenticationResultType.add_member(:access_token, Shapes::ShapeRef.new(shape: TokenModelType, location_name: "AccessToken"))
|
752
755
|
AuthenticationResultType.add_member(:expires_in, Shapes::ShapeRef.new(shape: IntegerType, location_name: "ExpiresIn"))
|
@@ -933,6 +936,7 @@ module Aws::CognitoIdentityProvider
|
|
933
936
|
CreateUserPoolRequest.add_member(:admin_create_user_config, Shapes::ShapeRef.new(shape: AdminCreateUserConfigType, location_name: "AdminCreateUserConfig"))
|
934
937
|
CreateUserPoolRequest.add_member(:schema, Shapes::ShapeRef.new(shape: SchemaAttributesListType, location_name: "Schema"))
|
935
938
|
CreateUserPoolRequest.add_member(:user_pool_add_ons, Shapes::ShapeRef.new(shape: UserPoolAddOnsType, location_name: "UserPoolAddOns"))
|
939
|
+
CreateUserPoolRequest.add_member(:username_configuration, Shapes::ShapeRef.new(shape: UsernameConfigurationType, location_name: "UsernameConfiguration"))
|
936
940
|
CreateUserPoolRequest.add_member(:account_recovery_setting, Shapes::ShapeRef.new(shape: AccountRecoverySettingType, location_name: "AccountRecoverySetting"))
|
937
941
|
CreateUserPoolRequest.struct_class = Types::CreateUserPoolRequest
|
938
942
|
|
@@ -1866,6 +1870,7 @@ module Aws::CognitoIdentityProvider
|
|
1866
1870
|
UserPoolType.add_member(:custom_domain, Shapes::ShapeRef.new(shape: DomainType, location_name: "CustomDomain"))
|
1867
1871
|
UserPoolType.add_member(:admin_create_user_config, Shapes::ShapeRef.new(shape: AdminCreateUserConfigType, location_name: "AdminCreateUserConfig"))
|
1868
1872
|
UserPoolType.add_member(:user_pool_add_ons, Shapes::ShapeRef.new(shape: UserPoolAddOnsType, location_name: "UserPoolAddOns"))
|
1873
|
+
UserPoolType.add_member(:username_configuration, Shapes::ShapeRef.new(shape: UsernameConfigurationType, location_name: "UsernameConfiguration"))
|
1869
1874
|
UserPoolType.add_member(:arn, Shapes::ShapeRef.new(shape: ArnType, location_name: "Arn"))
|
1870
1875
|
UserPoolType.add_member(:account_recovery_setting, Shapes::ShapeRef.new(shape: AccountRecoverySettingType, location_name: "AccountRecoverySetting"))
|
1871
1876
|
UserPoolType.struct_class = Types::UserPoolType
|
@@ -1881,6 +1886,9 @@ module Aws::CognitoIdentityProvider
|
|
1881
1886
|
|
1882
1887
|
UsernameAttributesListType.member = Shapes::ShapeRef.new(shape: UsernameAttributeType)
|
1883
1888
|
|
1889
|
+
UsernameConfigurationType.add_member(:case_sensitive, Shapes::ShapeRef.new(shape: WrappedBooleanType, required: true, location_name: "CaseSensitive"))
|
1890
|
+
UsernameConfigurationType.struct_class = Types::UsernameConfigurationType
|
1891
|
+
|
1884
1892
|
UsernameExistsException.add_member(:message, Shapes::ShapeRef.new(shape: MessageType, location_name: "message"))
|
1885
1893
|
UsernameExistsException.struct_class = Types::UsernameExistsException
|
1886
1894
|
|
@@ -943,7 +943,7 @@ module Aws::CognitoIdentityProvider
|
|
943
943
|
# client_id: "ClientIdType", # required
|
944
944
|
# 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
|
945
945
|
# auth_parameters: {
|
946
|
-
# "StringType" => "
|
946
|
+
# "StringType" => "AuthParametersValueType",
|
947
947
|
# },
|
948
948
|
# client_metadata: {
|
949
949
|
# "StringType" => "StringType",
|
@@ -2940,8 +2940,60 @@ module Aws::CognitoIdentityProvider
|
|
2940
2940
|
# @return [String]
|
2941
2941
|
#
|
2942
2942
|
# @!attribute [rw] provider_details
|
2943
|
-
# The identity provider details
|
2944
|
-
#
|
2943
|
+
# The identity provider details. The following list describes the
|
2944
|
+
# provider detail keys for each identity provider type.
|
2945
|
+
#
|
2946
|
+
# * For Google, Facebook and Login with Amazon:
|
2947
|
+
#
|
2948
|
+
# * client\_id
|
2949
|
+
#
|
2950
|
+
# * client\_secret
|
2951
|
+
#
|
2952
|
+
# * authorize\_scopes
|
2953
|
+
#
|
2954
|
+
# * For Sign in with Apple:
|
2955
|
+
#
|
2956
|
+
# * client\_id
|
2957
|
+
#
|
2958
|
+
# * team\_id
|
2959
|
+
#
|
2960
|
+
# * key\_id
|
2961
|
+
#
|
2962
|
+
# * private\_key
|
2963
|
+
#
|
2964
|
+
# * authorize\_scopes
|
2965
|
+
#
|
2966
|
+
# * For OIDC providers:
|
2967
|
+
#
|
2968
|
+
# * client\_id
|
2969
|
+
#
|
2970
|
+
# * client\_secret
|
2971
|
+
#
|
2972
|
+
# * attributes\_request\_method
|
2973
|
+
#
|
2974
|
+
# * oidc\_issuer
|
2975
|
+
#
|
2976
|
+
# * authorize\_scopes
|
2977
|
+
#
|
2978
|
+
# * authorize\_url *if not available from discovery URL specified by
|
2979
|
+
# oidc\_issuer key*
|
2980
|
+
#
|
2981
|
+
# * token\_url *if not available from discovery URL specified by
|
2982
|
+
# oidc\_issuer key*
|
2983
|
+
#
|
2984
|
+
# * attributes\_url *if not available from discovery URL specified
|
2985
|
+
# by oidc\_issuer key*
|
2986
|
+
#
|
2987
|
+
# * jwks\_uri *if not available from discovery URL specified by
|
2988
|
+
# oidc\_issuer key*
|
2989
|
+
#
|
2990
|
+
# * authorize\_scopes
|
2991
|
+
#
|
2992
|
+
# * For SAML providers:
|
2993
|
+
#
|
2994
|
+
# * MetadataFile OR MetadataURL
|
2995
|
+
#
|
2996
|
+
# * IDPSignOut *optional*
|
2945
2997
|
# @return [Hash<String,String>]
|
2946
2998
|
#
|
2947
2999
|
# @!attribute [rw] attribute_mapping
|
@@ -3233,23 +3285,29 @@ module Aws::CognitoIdentityProvider
|
|
3233
3285
|
# @return [String]
|
3234
3286
|
#
|
3235
3287
|
# @!attribute [rw] allowed_o_auth_flows
|
3288
|
+
# The allowed OAuth flows.
|
3289
|
+
#
|
3236
3290
|
# Set to `code` to initiate a code grant flow, which provides an
|
3237
3291
|
# authorization code as the response. This code can be exchanged for
|
3238
3292
|
# access tokens with the token endpoint.
|
3239
3293
|
#
|
3240
|
-
# Set to `
|
3294
|
+
# Set to `implicit` to specify that the client should get the access
|
3241
3295
|
# token (and, optionally, ID token, based on scopes) directly.
|
3296
|
+
#
|
3297
|
+
# Set to `client_credentials` to specify that the client should get
|
3298
|
+
# the access token (and, optionally, ID token, based on scopes) from
|
3299
|
+
# the token endpoint using a combination of client and client\_secret.
|
3242
3300
|
# @return [Array<String>]
|
3243
3301
|
#
|
3244
3302
|
# @!attribute [rw] allowed_o_auth_scopes
|
3245
|
-
#
|
3246
|
-
# `
|
3247
|
-
#
|
3248
|
-
# supported.
|
3303
|
+
# The allowed OAuth scopes. Possible values provided by OAuth are:
|
3304
|
+
# `phone`, `email`, `openid`, and `profile`. Possible values provided
|
3305
|
+
# by AWS are: `aws.cognito.signin.user.admin`. Custom scopes created
|
3306
|
+
# in Resource Servers are also supported.
|
3249
3307
|
# @return [Array<String>]
|
3250
3308
|
#
|
3251
3309
|
# @!attribute [rw] allowed_o_auth_flows_user_pool_client
|
3252
|
-
# Set to
|
3310
|
+
# Set to true if the client is allowed to follow the OAuth protocol
|
3253
3311
|
# when interacting with Cognito user pools.
|
3254
3312
|
# @return [Boolean]
|
3255
3313
|
#
|
@@ -3294,7 +3352,7 @@ module Aws::CognitoIdentityProvider
|
|
3294
3352
|
#
|
3295
3353
|
# * ResendConfirmationCode
|
3296
3354
|
#
|
3297
|
-
# <note markdown="1"> After
|
3355
|
+
# <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
|
3298
3356
|
# will default to `ENABLED` for newly created user pool clients if no
|
3299
3357
|
# value is provided.
|
3300
3358
|
#
|
@@ -3484,6 +3542,9 @@ module Aws::CognitoIdentityProvider
|
|
3484
3542
|
# user_pool_add_ons: {
|
3485
3543
|
# advanced_security_mode: "OFF", # required, accepts OFF, AUDIT, ENFORCED
|
3486
3544
|
# },
|
3545
|
+
# username_configuration: {
|
3546
|
+
# case_sensitive: false, # required
|
3547
|
+
# },
|
3487
3548
|
# account_recovery_setting: {
|
3488
3549
|
# recovery_mechanisms: [
|
3489
3550
|
# {
|
@@ -3597,6 +3658,14 @@ module Aws::CognitoIdentityProvider
|
|
3597
3658
|
# `AdvancedSecurityMode` to the value "AUDIT".
|
3598
3659
|
# @return [Types::UserPoolAddOnsType]
|
3599
3660
|
#
|
3661
|
+
# @!attribute [rw] username_configuration
|
3662
|
+
# You can choose to set case sensitivity on the username input for the
|
3663
|
+
# selected sign-in option. For example, when this is set to `False`,
|
3664
|
+
# users will be able to sign in using either "username" or
|
3665
|
+
# "Username". This configuration is immutable once it has been set.
|
3666
|
+
# For more information, see .
|
3667
|
+
# @return [Types::UsernameConfigurationType]
|
3668
|
+
#
|
3600
3669
|
# @!attribute [rw] account_recovery_setting
|
3601
3670
|
# Use this setting to define which verified available method a user
|
3602
3671
|
# can use to recover their password when they call `ForgotPassword`.
|
@@ -3637,6 +3706,7 @@ module Aws::CognitoIdentityProvider
|
|
3637
3706
|
:admin_create_user_config,
|
3638
3707
|
:schema,
|
3639
3708
|
:user_pool_add_ons,
|
3709
|
+
:username_configuration,
|
3640
3710
|
:account_recovery_setting)
|
3641
3711
|
include Aws::Structure
|
3642
3712
|
end
|
@@ -5193,8 +5263,60 @@ module Aws::CognitoIdentityProvider
|
|
5193
5263
|
# @return [String]
|
5194
5264
|
#
|
5195
5265
|
# @!attribute [rw] provider_details
|
5196
|
-
# The identity provider details
|
5197
|
-
#
|
5266
|
+
# The identity provider details. The following list describes the
|
5267
|
+
# provider detail keys for each identity provider type.
|
5268
|
+
#
|
5269
|
+
# * For Google, Facebook and Login with Amazon:
|
5270
|
+
#
|
5271
|
+
# * client\_id
|
5272
|
+
#
|
5273
|
+
# * client\_secret
|
5274
|
+
#
|
5275
|
+
# * authorize\_scopes
|
5276
|
+
#
|
5277
|
+
# * For Sign in with Apple:
|
5278
|
+
#
|
5279
|
+
# * client\_id
|
5280
|
+
#
|
5281
|
+
# * team\_id
|
5282
|
+
#
|
5283
|
+
# * key\_id
|
5284
|
+
#
|
5285
|
+
# * private\_key
|
5286
|
+
#
|
5287
|
+
# * authorize\_scopes
|
5288
|
+
#
|
5289
|
+
# * For OIDC providers:
|
5290
|
+
#
|
5291
|
+
# * client\_id
|
5292
|
+
#
|
5293
|
+
# * client\_secret
|
5294
|
+
#
|
5295
|
+
# * attributes\_request\_method
|
5296
|
+
#
|
5297
|
+
# * oidc\_issuer
|
5298
|
+
#
|
5299
|
+
# * authorize\_scopes
|
5300
|
+
#
|
5301
|
+
# * authorize\_url *if not available from discovery URL specified by
|
5302
|
+
# oidc\_issuer key*
|
5303
|
+
#
|
5304
|
+
# * token\_url *if not available from discovery URL specified by
|
5305
|
+
# oidc\_issuer key*
|
5306
|
+
#
|
5307
|
+
# * attributes\_url *if not available from discovery URL specified
|
5308
|
+
# by oidc\_issuer key*
|
5309
|
+
#
|
5310
|
+
# * jwks\_uri *if not available from discovery URL specified by
|
5311
|
+
# oidc\_issuer key*
|
5312
|
+
#
|
5313
|
+
# * authorize\_scopes
|
5314
|
+
#
|
5315
|
+
# * For SAML providers:
|
5316
|
+
#
|
5317
|
+
# * MetadataFile OR MetadataURL
|
5318
|
+
#
|
5319
|
+
# * IDPSignOut *optional*
|
5198
5320
|
# @return [Hash<String,String>]
|
5199
5321
|
#
|
5200
5322
|
# @!attribute [rw] attribute_mapping
|
@@ -5236,7 +5358,7 @@ module Aws::CognitoIdentityProvider
|
|
5236
5358
|
# {
|
5237
5359
|
# 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
|
5238
5360
|
# auth_parameters: {
|
5239
|
-
# "StringType" => "
|
5361
|
+
# "StringType" => "AuthParametersValueType",
|
5240
5362
|
# },
|
5241
5363
|
# client_metadata: {
|
5242
5364
|
# "StringType" => "StringType",
|
@@ -7144,7 +7266,21 @@ module Aws::CognitoIdentityProvider
|
|
7144
7266
|
# @return [String]
|
7145
7267
|
#
|
7146
7268
|
# @!attribute [rw] developer_only_attribute
|
7147
|
-
#
|
7269
|
+
# <note markdown="1"> We recommend that you use [WriteAttributes][1] in the user pool
|
7270
|
+
# client to control how attributes can be mutated for new use cases
|
7271
|
+
# instead of using `DeveloperOnlyAttribute`.
|
7272
|
+
#
|
7273
|
+
# </note>
|
7274
|
+
#
|
7275
|
+
# Specifies whether the attribute type is developer only. This
|
7276
|
+
# attribute can only be modified by an administrator. Users will not
|
7277
|
+
# be able to modify this attribute using their access token. For
|
7278
|
+
# example, `DeveloperOnlyAttribute` can be modified using the API but
|
7279
|
+
# cannot be updated using the API.
|
7280
|
+
#
|
7281
|
+
#
|
7282
|
+
#
|
7283
|
+
# [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes
|
7148
7284
|
# @return [Boolean]
|
7149
7285
|
#
|
7150
7286
|
# @!attribute [rw] mutable
|
@@ -8558,20 +8694,29 @@ module Aws::CognitoIdentityProvider
|
|
8558
8694
|
# @return [String]
|
8559
8695
|
#
|
8560
8696
|
# @!attribute [rw] allowed_o_auth_flows
|
8697
|
+
# The allowed OAuth flows.
|
8698
|
+
#
|
8561
8699
|
# Set to `code` to initiate a code grant flow, which provides an
|
8562
8700
|
# authorization code as the response. This code can be exchanged for
|
8563
8701
|
# access tokens with the token endpoint.
|
8702
|
+
#
|
8703
|
+
# Set to `implicit` to specify that the client should get the access
|
8704
|
+
# token (and, optionally, ID token, based on scopes) directly.
|
8705
|
+
#
|
8706
|
+
# Set to `client_credentials` to specify that the client should get
|
8707
|
+
# the access token (and, optionally, ID token, based on scopes) from
|
8708
|
+
# the token endpoint using a combination of client and client\_secret.
|
8564
8709
|
# @return [Array<String>]
|
8565
8710
|
#
|
8566
8711
|
# @!attribute [rw] allowed_o_auth_scopes
|
8567
|
-
#
|
8568
|
-
# `
|
8569
|
-
#
|
8570
|
-
# supported.
|
8712
|
+
# The allowed OAuth scopes. Possible values provided by OAuth are:
|
8713
|
+
# `phone`, `email`, `openid`, and `profile`. Possible values provided
|
8714
|
+
# by AWS are: `aws.cognito.signin.user.admin`. Custom scopes created
|
8715
|
+
# in Resource Servers are also supported.
|
8571
8716
|
# @return [Array<String>]
|
8572
8717
|
#
|
8573
8718
|
# @!attribute [rw] allowed_o_auth_flows_user_pool_client
|
8574
|
-
# Set to
|
8719
|
+
# Set to true if the client is allowed to follow the OAuth protocol
|
8575
8720
|
# when interacting with Cognito user pools.
|
8576
8721
|
# @return [Boolean]
|
8577
8722
|
#
|
@@ -8616,7 +8761,7 @@ module Aws::CognitoIdentityProvider
|
|
8616
8761
|
#
|
8617
8762
|
# * ResendConfirmationCode
|
8618
8763
|
#
|
8619
|
-
# <note markdown="1"> After
|
8764
|
+
# <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
|
8620
8765
|
# will default to `ENABLED` for newly created user pool clients if no
|
8621
8766
|
# value is provided.
|
8622
8767
|
#
|
@@ -9273,23 +9418,29 @@ module Aws::CognitoIdentityProvider
|
|
9273
9418
|
# @return [String]
|
9274
9419
|
#
|
9275
9420
|
# @!attribute [rw] allowed_o_auth_flows
|
9421
|
+
# The allowed OAuth flows.
|
9422
|
+
#
|
9276
9423
|
# Set to `code` to initiate a code grant flow, which provides an
|
9277
9424
|
# authorization code as the response. This code can be exchanged for
|
9278
9425
|
# access tokens with the token endpoint.
|
9279
9426
|
#
|
9280
|
-
# Set to `
|
9427
|
+
# Set to `implicit` to specify that the client should get the access
|
9281
9428
|
# token (and, optionally, ID token, based on scopes) directly.
|
9429
|
+
#
|
9430
|
+
# Set to `client_credentials` to specify that the client should get
|
9431
|
+
# the access token (and, optionally, ID token, based on scopes) from
|
9432
|
+
# the token endpoint using a combination of client and client\_secret.
|
9282
9433
|
# @return [Array<String>]
|
9283
9434
|
#
|
9284
9435
|
# @!attribute [rw] allowed_o_auth_scopes
|
9285
|
-
#
|
9286
|
-
# `
|
9287
|
-
#
|
9288
|
-
# supported.
|
9436
|
+
# The allowed OAuth scopes. Possible values provided by OAuth are:
|
9437
|
+
# `phone`, `email`, `openid`, and `profile`. Possible values provided
|
9438
|
+
# by AWS are: `aws.cognito.signin.user.admin`. Custom scopes created
|
9439
|
+
# in Resource Servers are also supported.
|
9289
9440
|
# @return [Array<String>]
|
9290
9441
|
#
|
9291
9442
|
# @!attribute [rw] allowed_o_auth_flows_user_pool_client
|
9292
|
-
# Set to
|
9443
|
+
# Set to true if the client is allowed to follow the OAuth protocol
|
9293
9444
|
# when interacting with Cognito user pools.
|
9294
9445
|
# @return [Boolean]
|
9295
9446
|
#
|
@@ -9334,7 +9485,7 @@ module Aws::CognitoIdentityProvider
|
|
9334
9485
|
#
|
9335
9486
|
# * ResendConfirmationCode
|
9336
9487
|
#
|
9337
|
-
# <note markdown="1"> After
|
9488
|
+
# <note markdown="1"> After February 15th 2020, the value of `PreventUserExistenceErrors`
|
9338
9489
|
# will default to `ENABLED` for newly created user pool clients if no
|
9339
9490
|
# value is provided.
|
9340
9491
|
#
|
@@ -9584,6 +9735,14 @@ module Aws::CognitoIdentityProvider
|
|
9584
9735
|
# The user pool add-ons.
|
9585
9736
|
# @return [Types::UserPoolAddOnsType]
|
9586
9737
|
#
|
9738
|
+
# @!attribute [rw] username_configuration
|
9739
|
+
# You can choose to enable case sensitivity on the username input for
|
9740
|
+
# the selected sign-in option. For example, when this is set to
|
9741
|
+
# `False`, users will be able to sign in using either "username" or
|
9742
|
+
# "Username". This configuration is immutable once it has been set.
|
9743
|
+
# For more information, see .
|
9744
|
+
# @return [Types::UsernameConfigurationType]
|
9745
|
+
#
|
9587
9746
|
# @!attribute [rw] arn
|
9588
9747
|
# The Amazon Resource Name (ARN) for the user pool.
|
9589
9748
|
# @return [String]
|
@@ -9630,6 +9789,7 @@ module Aws::CognitoIdentityProvider
|
|
9630
9789
|
:custom_domain,
|
9631
9790
|
:admin_create_user_config,
|
9632
9791
|
:user_pool_add_ons,
|
9792
|
+
:username_configuration,
|
9633
9793
|
:arn,
|
9634
9794
|
:account_recovery_setting)
|
9635
9795
|
include Aws::Structure
|
@@ -9696,6 +9856,41 @@ module Aws::CognitoIdentityProvider
|
|
9696
9856
|
include Aws::Structure
|
9697
9857
|
end
|
9698
9858
|
|
9859
|
+
# The username configuration type.
|
9860
|
+
#
|
9861
|
+
# @note When making an API call, you may pass UsernameConfigurationType
|
9862
|
+
# data as a hash:
|
9863
|
+
#
|
9864
|
+
# {
|
9865
|
+
# case_sensitive: false, # required
|
9866
|
+
# }
|
9867
|
+
#
|
9868
|
+
# @!attribute [rw] case_sensitive
|
9869
|
+
# Specifies whether username case sensitivity will be applied for all
|
9870
|
+
# users in the user pool through Cognito APIs.
|
9871
|
+
#
|
9872
|
+
# Valid values include:
|
9873
|
+
#
|
9874
|
+
# * <b> <code>True</code> </b>\: Enables case sensitivity for all
|
9875
|
+
# username input. When this option is set to `True`, users must sign
|
9876
|
+
# in using the exact capitalization of their given username. For
|
9877
|
+
# example, “UserName”. This is the default value.
|
9878
|
+
#
|
9879
|
+
# * <b> <code>False</code> </b>\: Enables case insensitivity for all
|
9880
|
+
# username input. For example, when this option is set to `False`,
|
9881
|
+
# users will be able to sign in using either "username" or
|
9882
|
+
# "Username". This option also enables both `preferred_username`
|
9883
|
+
# and `email` alias to be case insensitive, in addition to the
|
9884
|
+
# `username` attribute.
|
9885
|
+
# @return [Boolean]
|
9886
|
+
#
|
9887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UsernameConfigurationType AWS API Documentation
|
9888
|
+
#
|
9889
|
+
class UsernameConfigurationType < Struct.new(
|
9890
|
+
:case_sensitive)
|
9891
|
+
include Aws::Structure
|
9892
|
+
end
|
9893
|
+
|
9699
9894
|
# This exception is thrown when Amazon Cognito encounters a user name
|
9700
9895
|
# that already exists in the user pool.
|
9701
9896
|
#
|
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.32.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:
|
11
|
+
date: 2020-02-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|