aws-sdk-cognitoidentityprovider 1.107.0 → 1.109.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +85 -87
- data/lib/aws-sdk-cognitoidentityprovider/endpoint_parameters.rb +9 -6
- data/lib/aws-sdk-cognitoidentityprovider/endpoints.rb +2 -1131
- data/lib/aws-sdk-cognitoidentityprovider/plugins/endpoints.rb +1 -212
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +112 -114
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- metadata +4 -4
@@ -1434,12 +1434,12 @@ module Aws::CognitoIdentityProvider
|
|
1434
1434
|
# SMS\_MFA
|
1435
1435
|
#
|
1436
1436
|
# : `"ChallengeName": "SMS_MFA", "ChallengeResponses":
|
1437
|
-
#
|
1437
|
+
# {"SMS_MFA_CODE": "[code]", "USERNAME": "[username]"}`
|
1438
1438
|
#
|
1439
1439
|
# EMAIL\_OTP
|
1440
1440
|
#
|
1441
1441
|
# : `"ChallengeName": "EMAIL_OTP", "ChallengeResponses":
|
1442
|
-
#
|
1442
|
+
# {"EMAIL_OTP_CODE": "[code]", "USERNAME": "[username]"}`
|
1443
1443
|
#
|
1444
1444
|
# PASSWORD\_VERIFIER
|
1445
1445
|
#
|
@@ -1449,23 +1449,23 @@ module Aws::CognitoIdentityProvider
|
|
1449
1449
|
# pool returns a `NotAuthorizedException` error.
|
1450
1450
|
#
|
1451
1451
|
# `"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
|
1452
|
-
#
|
1452
|
+
# {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
|
1453
1453
|
# "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
1454
|
-
# [timestamp], "USERNAME": "[username]"
|
1454
|
+
# [timestamp], "USERNAME": "[username]"}`
|
1455
1455
|
#
|
1456
1456
|
# Add `"DEVICE_KEY"` when you sign in with a remembered device.
|
1457
1457
|
#
|
1458
1458
|
# CUSTOM\_CHALLENGE
|
1459
1459
|
#
|
1460
1460
|
# : `"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
|
1461
|
-
#
|
1461
|
+
# {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}`
|
1462
1462
|
#
|
1463
1463
|
# Add `"DEVICE_KEY"` when you sign in with a remembered device.
|
1464
1464
|
#
|
1465
1465
|
# NEW\_PASSWORD\_REQUIRED
|
1466
1466
|
#
|
1467
1467
|
# : `"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
|
1468
|
-
#
|
1468
|
+
# {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}`
|
1469
1469
|
#
|
1470
1470
|
# To set any required attributes that `InitiateAuth` returned in an
|
1471
1471
|
# `requiredAttributes` parameter, add
|
@@ -1485,34 +1485,33 @@ module Aws::CognitoIdentityProvider
|
|
1485
1485
|
# SOFTWARE\_TOKEN\_MFA
|
1486
1486
|
#
|
1487
1487
|
# : `"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
|
1488
|
-
#
|
1489
|
-
# [authenticator_code]
|
1488
|
+
# {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
|
1489
|
+
# [authenticator_code]}`
|
1490
1490
|
#
|
1491
1491
|
# DEVICE\_SRP\_AUTH
|
1492
1492
|
#
|
1493
1493
|
# : `"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses":
|
1494
|
-
#
|
1495
|
-
# "[srp_a]"
|
1494
|
+
# {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
|
1495
|
+
# "[srp_a]"}`
|
1496
1496
|
#
|
1497
1497
|
# DEVICE\_PASSWORD\_VERIFIER
|
1498
1498
|
#
|
1499
1499
|
# : `"ChallengeName": "DEVICE_PASSWORD_VERIFIER",
|
1500
|
-
# "ChallengeResponses":
|
1500
|
+
# "ChallengeResponses": {"DEVICE_KEY": "[device_key]",
|
1501
1501
|
# "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
|
1502
1502
|
# "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
1503
|
-
# [timestamp], "USERNAME": "[username]"
|
1503
|
+
# [timestamp], "USERNAME": "[username]"}`
|
1504
1504
|
#
|
1505
1505
|
# MFA\_SETUP
|
1506
1506
|
#
|
1507
|
-
# : `"ChallengeName": "MFA_SETUP", "ChallengeResponses":
|
1508
|
-
# "[username]"
|
1509
|
-
# VerifySoftwareToken]"`
|
1507
|
+
# : `"ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME":
|
1508
|
+
# "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"`
|
1510
1509
|
#
|
1511
1510
|
# SELECT\_MFA\_TYPE
|
1512
1511
|
#
|
1513
1512
|
# : `"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses":
|
1514
|
-
#
|
1515
|
-
# SOFTWARE_TOKEN_MFA]"
|
1513
|
+
# {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or
|
1514
|
+
# SOFTWARE_TOKEN_MFA]"}`
|
1516
1515
|
#
|
1517
1516
|
# For more information about `SECRET_HASH`, see [Computing secret hash
|
1518
1517
|
# values][1]. For information about `DEVICE_KEY`, see [Working with
|
@@ -2836,7 +2835,7 @@ module Aws::CognitoIdentityProvider
|
|
2836
2835
|
# discover endpoint URLs from `oidc_issuer`: `attributes_url`,
|
2837
2836
|
# `authorize_url`, `jwks_uri`, `token_url`.
|
2838
2837
|
#
|
2839
|
-
# Create or update request: `"ProviderDetails":
|
2838
|
+
# Create or update request: `"ProviderDetails": {
|
2840
2839
|
# "attributes_request_method": "GET", "attributes_url":
|
2841
2840
|
# "https://auth.example.com/userInfo", "authorize_scopes": "openid
|
2842
2841
|
# profile email", "authorize_url":
|
@@ -2844,9 +2843,9 @@ module Aws::CognitoIdentityProvider
|
|
2844
2843
|
# "1example23456789", "client_secret": "provider-app-client-secret",
|
2845
2844
|
# "jwks_uri": "https://auth.example.com/.well-known/jwks.json",
|
2846
2845
|
# "oidc_issuer": "https://auth.example.com", "token_url":
|
2847
|
-
# "https://example.com/token"
|
2846
|
+
# "https://example.com/token" }`
|
2848
2847
|
#
|
2849
|
-
# Describe response: `"ProviderDetails":
|
2848
|
+
# Describe response: `"ProviderDetails": {
|
2850
2849
|
# "attributes_request_method": "GET", "attributes_url":
|
2851
2850
|
# "https://auth.example.com/userInfo",
|
2852
2851
|
# "attributes_url_add_attributes": "false", "authorize_scopes":
|
@@ -2855,56 +2854,56 @@ module Aws::CognitoIdentityProvider
|
|
2855
2854
|
# "1example23456789", "client_secret": "provider-app-client-secret",
|
2856
2855
|
# "jwks_uri": "https://auth.example.com/.well-known/jwks.json",
|
2857
2856
|
# "oidc_issuer": "https://auth.example.com", "token_url":
|
2858
|
-
# "https://example.com/token"
|
2857
|
+
# "https://example.com/token" }`
|
2859
2858
|
#
|
2860
2859
|
# SAML
|
2861
2860
|
#
|
2862
|
-
# : Create or update request with Metadata URL: `"ProviderDetails":
|
2861
|
+
# : Create or update request with Metadata URL: `"ProviderDetails": {
|
2863
2862
|
# "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" :
|
2864
2863
|
# "true", "MetadataURL":
|
2865
2864
|
# "https://auth.example.com/sso/saml/metadata",
|
2866
|
-
# "RequestSigningAlgorithm": "rsa-sha256"
|
2865
|
+
# "RequestSigningAlgorithm": "rsa-sha256" }`
|
2867
2866
|
#
|
2868
|
-
# Create or update request with Metadata file: `"ProviderDetails":
|
2869
|
-
#
|
2867
|
+
# Create or update request with Metadata file: `"ProviderDetails": {
|
2868
|
+
# "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" :
|
2870
2869
|
# "true", "MetadataFile": "[metadata XML]",
|
2871
|
-
# "RequestSigningAlgorithm": "rsa-sha256"
|
2870
|
+
# "RequestSigningAlgorithm": "rsa-sha256" }`
|
2872
2871
|
#
|
2873
2872
|
# The value of `MetadataFile` must be the plaintext metadata
|
2874
2873
|
# document with all quote (") characters escaped by backslashes.
|
2875
2874
|
#
|
2876
|
-
# Describe response: `"ProviderDetails":
|
2875
|
+
# Describe response: `"ProviderDetails": { "IDPInit": "true",
|
2877
2876
|
# "IDPSignout": "true", "EncryptedResponses" : "true",
|
2878
2877
|
# "ActiveEncryptionCertificate": "[certificate]", "MetadataURL":
|
2879
2878
|
# "https://auth.example.com/sso/saml/metadata",
|
2880
2879
|
# "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI":
|
2881
2880
|
# "https://auth.example.com/slo/saml", "SSORedirectBindingURI":
|
2882
|
-
# "https://auth.example.com/sso/saml"
|
2881
|
+
# "https://auth.example.com/sso/saml" }`
|
2883
2882
|
#
|
2884
2883
|
# LoginWithAmazon
|
2885
2884
|
#
|
2886
|
-
# : Create or update request: `"ProviderDetails":
|
2885
|
+
# : Create or update request: `"ProviderDetails": {
|
2887
2886
|
# "authorize_scopes": "profile postal_code", "client_id":
|
2888
2887
|
# "amzn1.application-oa2-client.1example23456789", "client_secret":
|
2889
2888
|
# "provider-app-client-secret"`
|
2890
2889
|
#
|
2891
|
-
# Describe response: `"ProviderDetails":
|
2890
|
+
# Describe response: `"ProviderDetails": { "attributes_url":
|
2892
2891
|
# "https://api.amazon.com/user/profile",
|
2893
2892
|
# "attributes_url_add_attributes": "false", "authorize_scopes":
|
2894
2893
|
# "profile postal_code", "authorize_url":
|
2895
2894
|
# "https://www.amazon.com/ap/oa", "client_id":
|
2896
2895
|
# "amzn1.application-oa2-client.1example23456789", "client_secret":
|
2897
2896
|
# "provider-app-client-secret", "token_request_method": "POST",
|
2898
|
-
# "token_url": "https://api.amazon.com/auth/o2/token"
|
2897
|
+
# "token_url": "https://api.amazon.com/auth/o2/token" }`
|
2899
2898
|
#
|
2900
2899
|
# Google
|
2901
2900
|
#
|
2902
|
-
# : Create or update request: `"ProviderDetails":
|
2901
|
+
# : Create or update request: `"ProviderDetails": {
|
2903
2902
|
# "authorize_scopes": "email profile openid", "client_id":
|
2904
2903
|
# "1example23456789.apps.googleusercontent.com", "client_secret":
|
2905
|
-
# "provider-app-client-secret"
|
2904
|
+
# "provider-app-client-secret" }`
|
2906
2905
|
#
|
2907
|
-
# Describe response: `"ProviderDetails":
|
2906
|
+
# Describe response: `"ProviderDetails": { "attributes_url":
|
2908
2907
|
# "https://people.googleapis.com/v1/people/me?personFields=",
|
2909
2908
|
# "attributes_url_add_attributes": "true", "authorize_scopes":
|
2910
2909
|
# "email profile openid", "authorize_url":
|
@@ -2912,39 +2911,39 @@ module Aws::CognitoIdentityProvider
|
|
2912
2911
|
# "1example23456789.apps.googleusercontent.com", "client_secret":
|
2913
2912
|
# "provider-app-client-secret", "oidc_issuer":
|
2914
2913
|
# "https://accounts.google.com", "token_request_method": "POST",
|
2915
|
-
# "token_url": "https://www.googleapis.com/oauth2/v4/token"
|
2914
|
+
# "token_url": "https://www.googleapis.com/oauth2/v4/token" }`
|
2916
2915
|
#
|
2917
2916
|
# SignInWithApple
|
2918
2917
|
#
|
2919
|
-
# : Create or update request: `"ProviderDetails":
|
2918
|
+
# : Create or update request: `"ProviderDetails": {
|
2920
2919
|
# "authorize_scopes": "email name", "client_id":
|
2921
2920
|
# "com.example.cognito", "private_key": "1EXAMPLE", "key_id":
|
2922
|
-
# "2EXAMPLE", "team_id": "3EXAMPLE"
|
2921
|
+
# "2EXAMPLE", "team_id": "3EXAMPLE" }`
|
2923
2922
|
#
|
2924
|
-
# Describe response: `"ProviderDetails":
|
2923
|
+
# Describe response: `"ProviderDetails": {
|
2925
2924
|
# "attributes_url_add_attributes": "false", "authorize_scopes":
|
2926
2925
|
# "email name", "authorize_url":
|
2927
2926
|
# "https://appleid.apple.com/auth/authorize", "client_id":
|
2928
2927
|
# "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer":
|
2929
2928
|
# "https://appleid.apple.com", "team_id": "2EXAMPLE",
|
2930
2929
|
# "token_request_method": "POST", "token_url":
|
2931
|
-
# "https://appleid.apple.com/auth/token"
|
2930
|
+
# "https://appleid.apple.com/auth/token" }`
|
2932
2931
|
#
|
2933
2932
|
# Facebook
|
2934
2933
|
#
|
2935
|
-
# : Create or update request: `"ProviderDetails":
|
2934
|
+
# : Create or update request: `"ProviderDetails": { "api_version":
|
2936
2935
|
# "v17.0", "authorize_scopes": "public_profile, email", "client_id":
|
2937
2936
|
# "1example23456789", "client_secret": "provider-app-client-secret"
|
2938
|
-
#
|
2937
|
+
# }`
|
2939
2938
|
#
|
2940
|
-
# Describe response: `"ProviderDetails":
|
2939
|
+
# Describe response: `"ProviderDetails": { "api_version": "v17.0",
|
2941
2940
|
# "attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
|
2942
2941
|
# "attributes_url_add_attributes": "true", "authorize_scopes":
|
2943
2942
|
# "public_profile, email", "authorize_url":
|
2944
2943
|
# "https://www.facebook.com/v17.0/dialog/oauth", "client_id":
|
2945
2944
|
# "1example23456789", "client_secret": "provider-app-client-secret",
|
2946
2945
|
# "token_request_method": "GET", "token_url":
|
2947
|
-
# "https://graph.facebook.com/v17.0/oauth/access_token"
|
2946
|
+
# "https://graph.facebook.com/v17.0/oauth/access_token" }`
|
2948
2947
|
# @return [Hash<String,String>]
|
2949
2948
|
#
|
2950
2949
|
# @!attribute [rw] attribute_mapping
|
@@ -4546,7 +4545,7 @@ module Aws::CognitoIdentityProvider
|
|
4546
4545
|
#
|
4547
4546
|
# @!attribute [rw] message
|
4548
4547
|
# The template for the email message that your user pool sends to
|
4549
|
-
# users with an MFA code. The message must contain the
|
4548
|
+
# users with an MFA code. The message must contain the `{####}`
|
4550
4549
|
# placeholder. In the message, Amazon Cognito replaces this
|
4551
4550
|
# placeholder with the code. If you don't provide this parameter,
|
4552
4551
|
# Amazon Cognito sends messages in the default format.
|
@@ -5415,7 +5414,7 @@ module Aws::CognitoIdentityProvider
|
|
5415
5414
|
# discover endpoint URLs from `oidc_issuer`: `attributes_url`,
|
5416
5415
|
# `authorize_url`, `jwks_uri`, `token_url`.
|
5417
5416
|
#
|
5418
|
-
# Create or update request: `"ProviderDetails":
|
5417
|
+
# Create or update request: `"ProviderDetails": {
|
5419
5418
|
# "attributes_request_method": "GET", "attributes_url":
|
5420
5419
|
# "https://auth.example.com/userInfo", "authorize_scopes": "openid
|
5421
5420
|
# profile email", "authorize_url":
|
@@ -5423,9 +5422,9 @@ module Aws::CognitoIdentityProvider
|
|
5423
5422
|
# "1example23456789", "client_secret": "provider-app-client-secret",
|
5424
5423
|
# "jwks_uri": "https://auth.example.com/.well-known/jwks.json",
|
5425
5424
|
# "oidc_issuer": "https://auth.example.com", "token_url":
|
5426
|
-
# "https://example.com/token"
|
5425
|
+
# "https://example.com/token" }`
|
5427
5426
|
#
|
5428
|
-
# Describe response: `"ProviderDetails":
|
5427
|
+
# Describe response: `"ProviderDetails": {
|
5429
5428
|
# "attributes_request_method": "GET", "attributes_url":
|
5430
5429
|
# "https://auth.example.com/userInfo",
|
5431
5430
|
# "attributes_url_add_attributes": "false", "authorize_scopes":
|
@@ -5434,56 +5433,56 @@ module Aws::CognitoIdentityProvider
|
|
5434
5433
|
# "1example23456789", "client_secret": "provider-app-client-secret",
|
5435
5434
|
# "jwks_uri": "https://auth.example.com/.well-known/jwks.json",
|
5436
5435
|
# "oidc_issuer": "https://auth.example.com", "token_url":
|
5437
|
-
# "https://example.com/token"
|
5436
|
+
# "https://example.com/token" }`
|
5438
5437
|
#
|
5439
5438
|
# SAML
|
5440
5439
|
#
|
5441
|
-
# : Create or update request with Metadata URL: `"ProviderDetails":
|
5440
|
+
# : Create or update request with Metadata URL: `"ProviderDetails": {
|
5442
5441
|
# "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" :
|
5443
5442
|
# "true", "MetadataURL":
|
5444
5443
|
# "https://auth.example.com/sso/saml/metadata",
|
5445
|
-
# "RequestSigningAlgorithm": "rsa-sha256"
|
5444
|
+
# "RequestSigningAlgorithm": "rsa-sha256" }`
|
5446
5445
|
#
|
5447
|
-
# Create or update request with Metadata file: `"ProviderDetails":
|
5448
|
-
#
|
5446
|
+
# Create or update request with Metadata file: `"ProviderDetails": {
|
5447
|
+
# "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" :
|
5449
5448
|
# "true", "MetadataFile": "[metadata XML]",
|
5450
|
-
# "RequestSigningAlgorithm": "rsa-sha256"
|
5449
|
+
# "RequestSigningAlgorithm": "rsa-sha256" }`
|
5451
5450
|
#
|
5452
5451
|
# The value of `MetadataFile` must be the plaintext metadata
|
5453
5452
|
# document with all quote (") characters escaped by backslashes.
|
5454
5453
|
#
|
5455
|
-
# Describe response: `"ProviderDetails":
|
5454
|
+
# Describe response: `"ProviderDetails": { "IDPInit": "true",
|
5456
5455
|
# "IDPSignout": "true", "EncryptedResponses" : "true",
|
5457
5456
|
# "ActiveEncryptionCertificate": "[certificate]", "MetadataURL":
|
5458
5457
|
# "https://auth.example.com/sso/saml/metadata",
|
5459
5458
|
# "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI":
|
5460
5459
|
# "https://auth.example.com/slo/saml", "SSORedirectBindingURI":
|
5461
|
-
# "https://auth.example.com/sso/saml"
|
5460
|
+
# "https://auth.example.com/sso/saml" }`
|
5462
5461
|
#
|
5463
5462
|
# LoginWithAmazon
|
5464
5463
|
#
|
5465
|
-
# : Create or update request: `"ProviderDetails":
|
5464
|
+
# : Create or update request: `"ProviderDetails": {
|
5466
5465
|
# "authorize_scopes": "profile postal_code", "client_id":
|
5467
5466
|
# "amzn1.application-oa2-client.1example23456789", "client_secret":
|
5468
5467
|
# "provider-app-client-secret"`
|
5469
5468
|
#
|
5470
|
-
# Describe response: `"ProviderDetails":
|
5469
|
+
# Describe response: `"ProviderDetails": { "attributes_url":
|
5471
5470
|
# "https://api.amazon.com/user/profile",
|
5472
5471
|
# "attributes_url_add_attributes": "false", "authorize_scopes":
|
5473
5472
|
# "profile postal_code", "authorize_url":
|
5474
5473
|
# "https://www.amazon.com/ap/oa", "client_id":
|
5475
5474
|
# "amzn1.application-oa2-client.1example23456789", "client_secret":
|
5476
5475
|
# "provider-app-client-secret", "token_request_method": "POST",
|
5477
|
-
# "token_url": "https://api.amazon.com/auth/o2/token"
|
5476
|
+
# "token_url": "https://api.amazon.com/auth/o2/token" }`
|
5478
5477
|
#
|
5479
5478
|
# Google
|
5480
5479
|
#
|
5481
|
-
# : Create or update request: `"ProviderDetails":
|
5480
|
+
# : Create or update request: `"ProviderDetails": {
|
5482
5481
|
# "authorize_scopes": "email profile openid", "client_id":
|
5483
5482
|
# "1example23456789.apps.googleusercontent.com", "client_secret":
|
5484
|
-
# "provider-app-client-secret"
|
5483
|
+
# "provider-app-client-secret" }`
|
5485
5484
|
#
|
5486
|
-
# Describe response: `"ProviderDetails":
|
5485
|
+
# Describe response: `"ProviderDetails": { "attributes_url":
|
5487
5486
|
# "https://people.googleapis.com/v1/people/me?personFields=",
|
5488
5487
|
# "attributes_url_add_attributes": "true", "authorize_scopes":
|
5489
5488
|
# "email profile openid", "authorize_url":
|
@@ -5491,39 +5490,39 @@ module Aws::CognitoIdentityProvider
|
|
5491
5490
|
# "1example23456789.apps.googleusercontent.com", "client_secret":
|
5492
5491
|
# "provider-app-client-secret", "oidc_issuer":
|
5493
5492
|
# "https://accounts.google.com", "token_request_method": "POST",
|
5494
|
-
# "token_url": "https://www.googleapis.com/oauth2/v4/token"
|
5493
|
+
# "token_url": "https://www.googleapis.com/oauth2/v4/token" }`
|
5495
5494
|
#
|
5496
5495
|
# SignInWithApple
|
5497
5496
|
#
|
5498
|
-
# : Create or update request: `"ProviderDetails":
|
5497
|
+
# : Create or update request: `"ProviderDetails": {
|
5499
5498
|
# "authorize_scopes": "email name", "client_id":
|
5500
5499
|
# "com.example.cognito", "private_key": "1EXAMPLE", "key_id":
|
5501
|
-
# "2EXAMPLE", "team_id": "3EXAMPLE"
|
5500
|
+
# "2EXAMPLE", "team_id": "3EXAMPLE" }`
|
5502
5501
|
#
|
5503
|
-
# Describe response: `"ProviderDetails":
|
5502
|
+
# Describe response: `"ProviderDetails": {
|
5504
5503
|
# "attributes_url_add_attributes": "false", "authorize_scopes":
|
5505
5504
|
# "email name", "authorize_url":
|
5506
5505
|
# "https://appleid.apple.com/auth/authorize", "client_id":
|
5507
5506
|
# "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer":
|
5508
5507
|
# "https://appleid.apple.com", "team_id": "2EXAMPLE",
|
5509
5508
|
# "token_request_method": "POST", "token_url":
|
5510
|
-
# "https://appleid.apple.com/auth/token"
|
5509
|
+
# "https://appleid.apple.com/auth/token" }`
|
5511
5510
|
#
|
5512
5511
|
# Facebook
|
5513
5512
|
#
|
5514
|
-
# : Create or update request: `"ProviderDetails":
|
5513
|
+
# : Create or update request: `"ProviderDetails": { "api_version":
|
5515
5514
|
# "v17.0", "authorize_scopes": "public_profile, email", "client_id":
|
5516
5515
|
# "1example23456789", "client_secret": "provider-app-client-secret"
|
5517
|
-
#
|
5516
|
+
# }`
|
5518
5517
|
#
|
5519
|
-
# Describe response: `"ProviderDetails":
|
5518
|
+
# Describe response: `"ProviderDetails": { "api_version": "v17.0",
|
5520
5519
|
# "attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
|
5521
5520
|
# "attributes_url_add_attributes": "true", "authorize_scopes":
|
5522
5521
|
# "public_profile, email", "authorize_url":
|
5523
5522
|
# "https://www.facebook.com/v17.0/dialog/oauth", "client_id":
|
5524
5523
|
# "1example23456789", "client_secret": "provider-app-client-secret",
|
5525
5524
|
# "token_request_method": "GET", "token_url":
|
5526
|
-
# "https://graph.facebook.com/v17.0/oauth/access_token"
|
5525
|
+
# "https://graph.facebook.com/v17.0/oauth/access_token" }`
|
5527
5526
|
# @return [Hash<String,String>]
|
5528
5527
|
#
|
5529
5528
|
# @!attribute [rw] attribute_mapping
|
@@ -7340,12 +7339,12 @@ module Aws::CognitoIdentityProvider
|
|
7340
7339
|
# SMS\_MFA
|
7341
7340
|
#
|
7342
7341
|
# : `"ChallengeName": "SMS_MFA", "ChallengeResponses":
|
7343
|
-
#
|
7342
|
+
# {"SMS_MFA_CODE": "[code]", "USERNAME": "[username]"}`
|
7344
7343
|
#
|
7345
7344
|
# EMAIL\_OTP
|
7346
7345
|
#
|
7347
7346
|
# : `"ChallengeName": "EMAIL_OTP", "ChallengeResponses":
|
7348
|
-
#
|
7347
|
+
# {"EMAIL_OTP_CODE": "[code]", "USERNAME": "[username]"}`
|
7349
7348
|
#
|
7350
7349
|
# PASSWORD\_VERIFIER
|
7351
7350
|
#
|
@@ -7355,23 +7354,23 @@ module Aws::CognitoIdentityProvider
|
|
7355
7354
|
# pool returns a `NotAuthorizedException` error.
|
7356
7355
|
#
|
7357
7356
|
# `"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
|
7358
|
-
#
|
7357
|
+
# {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
|
7359
7358
|
# "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
7360
|
-
# [timestamp], "USERNAME": "[username]"
|
7359
|
+
# [timestamp], "USERNAME": "[username]"}`
|
7361
7360
|
#
|
7362
7361
|
# Add `"DEVICE_KEY"` when you sign in with a remembered device.
|
7363
7362
|
#
|
7364
7363
|
# CUSTOM\_CHALLENGE
|
7365
7364
|
#
|
7366
7365
|
# : `"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
|
7367
|
-
#
|
7366
|
+
# {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}`
|
7368
7367
|
#
|
7369
7368
|
# Add `"DEVICE_KEY"` when you sign in with a remembered device.
|
7370
7369
|
#
|
7371
7370
|
# NEW\_PASSWORD\_REQUIRED
|
7372
7371
|
#
|
7373
7372
|
# : `"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
|
7374
|
-
#
|
7373
|
+
# {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}`
|
7375
7374
|
#
|
7376
7375
|
# To set any required attributes that `InitiateAuth` returned in an
|
7377
7376
|
# `requiredAttributes` parameter, add
|
@@ -7391,34 +7390,33 @@ module Aws::CognitoIdentityProvider
|
|
7391
7390
|
# SOFTWARE\_TOKEN\_MFA
|
7392
7391
|
#
|
7393
7392
|
# : `"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
|
7394
|
-
#
|
7395
|
-
# [authenticator_code]
|
7393
|
+
# {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
|
7394
|
+
# [authenticator_code]}`
|
7396
7395
|
#
|
7397
7396
|
# DEVICE\_SRP\_AUTH
|
7398
7397
|
#
|
7399
7398
|
# : `"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses":
|
7400
|
-
#
|
7401
|
-
# "[srp_a]"
|
7399
|
+
# {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
|
7400
|
+
# "[srp_a]"}`
|
7402
7401
|
#
|
7403
7402
|
# DEVICE\_PASSWORD\_VERIFIER
|
7404
7403
|
#
|
7405
7404
|
# : `"ChallengeName": "DEVICE_PASSWORD_VERIFIER",
|
7406
|
-
# "ChallengeResponses":
|
7405
|
+
# "ChallengeResponses": {"DEVICE_KEY": "[device_key]",
|
7407
7406
|
# "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
|
7408
7407
|
# "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
7409
|
-
# [timestamp], "USERNAME": "[username]"
|
7408
|
+
# [timestamp], "USERNAME": "[username]"}`
|
7410
7409
|
#
|
7411
7410
|
# MFA\_SETUP
|
7412
7411
|
#
|
7413
|
-
# : `"ChallengeName": "MFA_SETUP", "ChallengeResponses":
|
7414
|
-
# "[username]"
|
7415
|
-
# VerifySoftwareToken]"`
|
7412
|
+
# : `"ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME":
|
7413
|
+
# "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"`
|
7416
7414
|
#
|
7417
7415
|
# SELECT\_MFA\_TYPE
|
7418
7416
|
#
|
7419
7417
|
# : `"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses":
|
7420
|
-
#
|
7421
|
-
# SOFTWARE_TOKEN_MFA]"
|
7418
|
+
# {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or
|
7419
|
+
# SOFTWARE_TOKEN_MFA]"}`
|
7422
7420
|
#
|
7423
7421
|
# For more information about `SECRET_HASH`, see [Computing secret hash
|
7424
7422
|
# values][1]. For information about `DEVICE_KEY`, see [Working with
|
@@ -8292,7 +8290,7 @@ module Aws::CognitoIdentityProvider
|
|
8292
8290
|
#
|
8293
8291
|
# @!attribute [rw] sms_authentication_message
|
8294
8292
|
# The SMS message that your user pool sends to users with an MFA code.
|
8295
|
-
# The message must contain the
|
8293
|
+
# The message must contain the `{####}` placeholder. In the message,
|
8296
8294
|
# Amazon Cognito replaces this placeholder with the code. If you
|
8297
8295
|
# don't provide this parameter, Amazon Cognito sends messages in the
|
8298
8296
|
# default format.
|
@@ -8862,7 +8860,7 @@ module Aws::CognitoIdentityProvider
|
|
8862
8860
|
# discover endpoint URLs from `oidc_issuer`: `attributes_url`,
|
8863
8861
|
# `authorize_url`, `jwks_uri`, `token_url`.
|
8864
8862
|
#
|
8865
|
-
# Create or update request: `"ProviderDetails":
|
8863
|
+
# Create or update request: `"ProviderDetails": {
|
8866
8864
|
# "attributes_request_method": "GET", "attributes_url":
|
8867
8865
|
# "https://auth.example.com/userInfo", "authorize_scopes": "openid
|
8868
8866
|
# profile email", "authorize_url":
|
@@ -8870,9 +8868,9 @@ module Aws::CognitoIdentityProvider
|
|
8870
8868
|
# "1example23456789", "client_secret": "provider-app-client-secret",
|
8871
8869
|
# "jwks_uri": "https://auth.example.com/.well-known/jwks.json",
|
8872
8870
|
# "oidc_issuer": "https://auth.example.com", "token_url":
|
8873
|
-
# "https://example.com/token"
|
8871
|
+
# "https://example.com/token" }`
|
8874
8872
|
#
|
8875
|
-
# Describe response: `"ProviderDetails":
|
8873
|
+
# Describe response: `"ProviderDetails": {
|
8876
8874
|
# "attributes_request_method": "GET", "attributes_url":
|
8877
8875
|
# "https://auth.example.com/userInfo",
|
8878
8876
|
# "attributes_url_add_attributes": "false", "authorize_scopes":
|
@@ -8881,56 +8879,56 @@ module Aws::CognitoIdentityProvider
|
|
8881
8879
|
# "1example23456789", "client_secret": "provider-app-client-secret",
|
8882
8880
|
# "jwks_uri": "https://auth.example.com/.well-known/jwks.json",
|
8883
8881
|
# "oidc_issuer": "https://auth.example.com", "token_url":
|
8884
|
-
# "https://example.com/token"
|
8882
|
+
# "https://example.com/token" }`
|
8885
8883
|
#
|
8886
8884
|
# SAML
|
8887
8885
|
#
|
8888
|
-
# : Create or update request with Metadata URL: `"ProviderDetails":
|
8886
|
+
# : Create or update request with Metadata URL: `"ProviderDetails": {
|
8889
8887
|
# "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" :
|
8890
8888
|
# "true", "MetadataURL":
|
8891
8889
|
# "https://auth.example.com/sso/saml/metadata",
|
8892
|
-
# "RequestSigningAlgorithm": "rsa-sha256"
|
8890
|
+
# "RequestSigningAlgorithm": "rsa-sha256" }`
|
8893
8891
|
#
|
8894
|
-
# Create or update request with Metadata file: `"ProviderDetails":
|
8895
|
-
#
|
8892
|
+
# Create or update request with Metadata file: `"ProviderDetails": {
|
8893
|
+
# "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" :
|
8896
8894
|
# "true", "MetadataFile": "[metadata XML]",
|
8897
|
-
# "RequestSigningAlgorithm": "rsa-sha256"
|
8895
|
+
# "RequestSigningAlgorithm": "rsa-sha256" }`
|
8898
8896
|
#
|
8899
8897
|
# The value of `MetadataFile` must be the plaintext metadata
|
8900
8898
|
# document with all quote (") characters escaped by backslashes.
|
8901
8899
|
#
|
8902
|
-
# Describe response: `"ProviderDetails":
|
8900
|
+
# Describe response: `"ProviderDetails": { "IDPInit": "true",
|
8903
8901
|
# "IDPSignout": "true", "EncryptedResponses" : "true",
|
8904
8902
|
# "ActiveEncryptionCertificate": "[certificate]", "MetadataURL":
|
8905
8903
|
# "https://auth.example.com/sso/saml/metadata",
|
8906
8904
|
# "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI":
|
8907
8905
|
# "https://auth.example.com/slo/saml", "SSORedirectBindingURI":
|
8908
|
-
# "https://auth.example.com/sso/saml"
|
8906
|
+
# "https://auth.example.com/sso/saml" }`
|
8909
8907
|
#
|
8910
8908
|
# LoginWithAmazon
|
8911
8909
|
#
|
8912
|
-
# : Create or update request: `"ProviderDetails":
|
8910
|
+
# : Create or update request: `"ProviderDetails": {
|
8913
8911
|
# "authorize_scopes": "profile postal_code", "client_id":
|
8914
8912
|
# "amzn1.application-oa2-client.1example23456789", "client_secret":
|
8915
8913
|
# "provider-app-client-secret"`
|
8916
8914
|
#
|
8917
|
-
# Describe response: `"ProviderDetails":
|
8915
|
+
# Describe response: `"ProviderDetails": { "attributes_url":
|
8918
8916
|
# "https://api.amazon.com/user/profile",
|
8919
8917
|
# "attributes_url_add_attributes": "false", "authorize_scopes":
|
8920
8918
|
# "profile postal_code", "authorize_url":
|
8921
8919
|
# "https://www.amazon.com/ap/oa", "client_id":
|
8922
8920
|
# "amzn1.application-oa2-client.1example23456789", "client_secret":
|
8923
8921
|
# "provider-app-client-secret", "token_request_method": "POST",
|
8924
|
-
# "token_url": "https://api.amazon.com/auth/o2/token"
|
8922
|
+
# "token_url": "https://api.amazon.com/auth/o2/token" }`
|
8925
8923
|
#
|
8926
8924
|
# Google
|
8927
8925
|
#
|
8928
|
-
# : Create or update request: `"ProviderDetails":
|
8926
|
+
# : Create or update request: `"ProviderDetails": {
|
8929
8927
|
# "authorize_scopes": "email profile openid", "client_id":
|
8930
8928
|
# "1example23456789.apps.googleusercontent.com", "client_secret":
|
8931
|
-
# "provider-app-client-secret"
|
8929
|
+
# "provider-app-client-secret" }`
|
8932
8930
|
#
|
8933
|
-
# Describe response: `"ProviderDetails":
|
8931
|
+
# Describe response: `"ProviderDetails": { "attributes_url":
|
8934
8932
|
# "https://people.googleapis.com/v1/people/me?personFields=",
|
8935
8933
|
# "attributes_url_add_attributes": "true", "authorize_scopes":
|
8936
8934
|
# "email profile openid", "authorize_url":
|
@@ -8938,39 +8936,39 @@ module Aws::CognitoIdentityProvider
|
|
8938
8936
|
# "1example23456789.apps.googleusercontent.com", "client_secret":
|
8939
8937
|
# "provider-app-client-secret", "oidc_issuer":
|
8940
8938
|
# "https://accounts.google.com", "token_request_method": "POST",
|
8941
|
-
# "token_url": "https://www.googleapis.com/oauth2/v4/token"
|
8939
|
+
# "token_url": "https://www.googleapis.com/oauth2/v4/token" }`
|
8942
8940
|
#
|
8943
8941
|
# SignInWithApple
|
8944
8942
|
#
|
8945
|
-
# : Create or update request: `"ProviderDetails":
|
8943
|
+
# : Create or update request: `"ProviderDetails": {
|
8946
8944
|
# "authorize_scopes": "email name", "client_id":
|
8947
8945
|
# "com.example.cognito", "private_key": "1EXAMPLE", "key_id":
|
8948
|
-
# "2EXAMPLE", "team_id": "3EXAMPLE"
|
8946
|
+
# "2EXAMPLE", "team_id": "3EXAMPLE" }`
|
8949
8947
|
#
|
8950
|
-
# Describe response: `"ProviderDetails":
|
8948
|
+
# Describe response: `"ProviderDetails": {
|
8951
8949
|
# "attributes_url_add_attributes": "false", "authorize_scopes":
|
8952
8950
|
# "email name", "authorize_url":
|
8953
8951
|
# "https://appleid.apple.com/auth/authorize", "client_id":
|
8954
8952
|
# "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer":
|
8955
8953
|
# "https://appleid.apple.com", "team_id": "2EXAMPLE",
|
8956
8954
|
# "token_request_method": "POST", "token_url":
|
8957
|
-
# "https://appleid.apple.com/auth/token"
|
8955
|
+
# "https://appleid.apple.com/auth/token" }`
|
8958
8956
|
#
|
8959
8957
|
# Facebook
|
8960
8958
|
#
|
8961
|
-
# : Create or update request: `"ProviderDetails":
|
8959
|
+
# : Create or update request: `"ProviderDetails": { "api_version":
|
8962
8960
|
# "v17.0", "authorize_scopes": "public_profile, email", "client_id":
|
8963
8961
|
# "1example23456789", "client_secret": "provider-app-client-secret"
|
8964
|
-
#
|
8962
|
+
# }`
|
8965
8963
|
#
|
8966
|
-
# Describe response: `"ProviderDetails":
|
8964
|
+
# Describe response: `"ProviderDetails": { "api_version": "v17.0",
|
8967
8965
|
# "attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
|
8968
8966
|
# "attributes_url_add_attributes": "true", "authorize_scopes":
|
8969
8967
|
# "public_profile, email", "authorize_url":
|
8970
8968
|
# "https://www.facebook.com/v17.0/dialog/oauth", "client_id":
|
8971
8969
|
# "1example23456789", "client_secret": "provider-app-client-secret",
|
8972
8970
|
# "token_request_method": "GET", "token_url":
|
8973
|
-
# "https://graph.facebook.com/v17.0/oauth/access_token"
|
8971
|
+
# "https://graph.facebook.com/v17.0/oauth/access_token" }`
|
8974
8972
|
# @return [Hash<String,String>]
|
8975
8973
|
#
|
8976
8974
|
# @!attribute [rw] attribute_mapping
|