aws-sdk-cognitoidentityprovider 1.0.0.rc12 → 1.0.0.rc13
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: cd678bb4c6552407237939174aeebe0d1e782f31
|
4
|
+
data.tar.gz: 60414f6b43cb64c982b8d66219799b134dedced2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9450110d66c015059737f52570b869c440d2662c8b4d0a87a6b1da497ba9926dcb413a5800a9f464eaa539b773bbe4f05e9e8bdeeb3dca392e5dbe330ff1139e
|
7
|
+
data.tar.gz: c226c0e8dc78d80218c82127ad379ed64b62de3f9f52f786fab68ff1929b41ff09d9c88e16afdd04e2aad90a377363f31e5a7571e23a999617839675b0aaac3d
|
@@ -484,6 +484,71 @@ module Aws::CognitoIdentityProvider
|
|
484
484
|
req.send_request(options)
|
485
485
|
end
|
486
486
|
|
487
|
+
# Disables the user from signing in with the specified external (SAML or
|
488
|
+
# social) identity provider. If the user to disable is a Cognito User
|
489
|
+
# Pools native username + password user, they are not permitted to use
|
490
|
+
# their password to sign-in. If the user to disable is a linked external
|
491
|
+
# IdP user, any link between that user and an existing user is removed.
|
492
|
+
# The next time the external user (no longer attached to the previously
|
493
|
+
# linked `DestinationUser`) signs in, they must create a new user
|
494
|
+
# account. See
|
495
|
+
# [AdminLinkProviderForUser](API_AdminLinkProviderForUser.html).
|
496
|
+
#
|
497
|
+
# This action is enabled only for admin access and requires developer
|
498
|
+
# credentials.
|
499
|
+
#
|
500
|
+
# The `ProviderName` must match the value specified when creating an IdP
|
501
|
+
# for the pool.
|
502
|
+
#
|
503
|
+
# To disable a native username + password user, the `ProviderName` value
|
504
|
+
# must be `Cognito` and the `ProviderAttributeName` must be
|
505
|
+
# `Cognito_Subject`, with the `ProviderAttributeValue` being the name
|
506
|
+
# that is used in the user pool for the user.
|
507
|
+
#
|
508
|
+
# The `ProviderAttributeName` must always be `Cognito_Subject` for
|
509
|
+
# social identity providers. The `ProviderAttributeValue` must always be
|
510
|
+
# the exact subject that was used when the user was originally linked as
|
511
|
+
# a source user.
|
512
|
+
#
|
513
|
+
# For de-linking a SAML identity, there are two scenarios. If the linked
|
514
|
+
# identity has not yet been used to sign-in, the `ProviderAttributeName`
|
515
|
+
# and `ProviderAttributeValue` must be the same values that were used
|
516
|
+
# for the `SourceUser` when the identities were originally linked in the
|
517
|
+
# [AdminLinkProviderForUser](API_AdminLinkProviderForUser.html) call.
|
518
|
+
# (If the linking was done with `ProviderAttributeName` set to
|
519
|
+
# `Cognito_Subject`, the same applies here). However, if the user has
|
520
|
+
# already signed in, the `ProviderAttributeName` must be
|
521
|
+
# `Cognito_Subject` and `ProviderAttributeValue` must be the subject of
|
522
|
+
# the SAML assertion.
|
523
|
+
#
|
524
|
+
# @option params [required, String] :user_pool_id
|
525
|
+
# The user pool ID for the user pool.
|
526
|
+
#
|
527
|
+
# @option params [required, Types::ProviderUserIdentifierType] :user
|
528
|
+
# The user to be disabled.
|
529
|
+
#
|
530
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
531
|
+
#
|
532
|
+
# @example Request syntax with placeholder values
|
533
|
+
#
|
534
|
+
# resp = client.admin_disable_provider_for_user({
|
535
|
+
# user_pool_id: "StringType", # required
|
536
|
+
# user: { # required
|
537
|
+
# provider_name: "ProviderNameType",
|
538
|
+
# provider_attribute_name: "StringType",
|
539
|
+
# provider_attribute_value: "StringType",
|
540
|
+
# },
|
541
|
+
# })
|
542
|
+
#
|
543
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableProviderForUser AWS API Documentation
|
544
|
+
#
|
545
|
+
# @overload admin_disable_provider_for_user(params = {})
|
546
|
+
# @param [Hash] params ({})
|
547
|
+
def admin_disable_provider_for_user(params = {}, options = {})
|
548
|
+
req = build_request(:admin_disable_provider_for_user, params)
|
549
|
+
req.send_request(options)
|
550
|
+
end
|
551
|
+
|
487
552
|
# Disables the specified user as an administrator. Works on any user.
|
488
553
|
#
|
489
554
|
# Requires developer credentials.
|
@@ -772,6 +837,97 @@ module Aws::CognitoIdentityProvider
|
|
772
837
|
req.send_request(options)
|
773
838
|
end
|
774
839
|
|
840
|
+
# Links an existing user account in a user pool (`DestinationUser`) to
|
841
|
+
# an identity from an external identity provider (`SourceUser`) based on
|
842
|
+
# a specified attribute name and value from the external identity
|
843
|
+
# provider. This allows you to create a link from the existing user
|
844
|
+
# account to an external federated user identity that has not yet been
|
845
|
+
# used to sign in, so that the federated user identity can be used to
|
846
|
+
# sign in as the existing user account.
|
847
|
+
#
|
848
|
+
# For example, if there is an existing user with a username and
|
849
|
+
# password, this API links that user to a federated user identity, so
|
850
|
+
# that when the federated user identity is used, the user signs in as
|
851
|
+
# the existing user account.
|
852
|
+
#
|
853
|
+
# Because this API allows a user with an external federated identity to
|
854
|
+
# sign in as an existing user in the user pool, it is critical that it
|
855
|
+
# only be used with external identity providers and provider attributes
|
856
|
+
# that have been trusted by the application owner.
|
857
|
+
#
|
858
|
+
# See also
|
859
|
+
# [AdminDisableProviderForUser](API_AdminDisableProviderForUser.html).
|
860
|
+
#
|
861
|
+
# This action is enabled only for admin access and requires developer
|
862
|
+
# credentials.
|
863
|
+
#
|
864
|
+
# @option params [required, String] :user_pool_id
|
865
|
+
# The user pool ID for the user pool.
|
866
|
+
#
|
867
|
+
# @option params [required, Types::ProviderUserIdentifierType] :destination_user
|
868
|
+
# The existing user in the user pool to be linked to the external
|
869
|
+
# identity provider user account. Can be a native (Username + Password)
|
870
|
+
# Cognito User Pools user or a federated user (for example, a SAML or
|
871
|
+
# Facebook user). If the user doesn't exist, an exception is thrown.
|
872
|
+
# This is the user that is returned when the new user (with the linked
|
873
|
+
# identity provider attribute) signs in.
|
874
|
+
#
|
875
|
+
# The `ProviderAttributeValue` for the `DestinationUser` must match the
|
876
|
+
# username for the user in the user pool. The `ProviderAttributeName`
|
877
|
+
# will always be ignored.
|
878
|
+
#
|
879
|
+
# @option params [required, Types::ProviderUserIdentifierType] :source_user
|
880
|
+
# An external identity provider account for a user who does not
|
881
|
+
# currently exist yet in the user pool. This user must be a federated
|
882
|
+
# user (for example, a SAML or Facebook user), not another native user.
|
883
|
+
#
|
884
|
+
# If the `SourceUser` is a federated social identity provider user
|
885
|
+
# (Facebook, Google, or Login with Amazon), you must set the
|
886
|
+
# `ProviderAttributeName` to `Cognito_Subject`. For social identity
|
887
|
+
# providers, the `ProviderName` will be `Facebook`, `Google`, or
|
888
|
+
# `LoginWithAmazon`, and Cognito will automatically parse the Facebook,
|
889
|
+
# Google, and Login with Amazon tokens for `id`, `sub`, and `user_id`,
|
890
|
+
# respectively. The `ProviderAttributeValue` for the user must be the
|
891
|
+
# same value as the `id`, `sub`, or `user_id` value found in the social
|
892
|
+
# identity provider token.
|
893
|
+
#
|
894
|
+
#
|
895
|
+
#
|
896
|
+
# For SAML, the `ProviderAttributeName` can be any value that matches a
|
897
|
+
# claim in the SAML assertion. If you wish to link SAML users based on
|
898
|
+
# the subject of the SAML assertion, you should map the subject to a
|
899
|
+
# claim through the SAML identity provider and submit that claim name as
|
900
|
+
# the `ProviderAttributeName`. If you set `ProviderAttributeName` to
|
901
|
+
# `Cognito_Subject`, Cognito will automatically parse the default unique
|
902
|
+
# identifier found in the subject from the SAML token.
|
903
|
+
#
|
904
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
905
|
+
#
|
906
|
+
# @example Request syntax with placeholder values
|
907
|
+
#
|
908
|
+
# resp = client.admin_link_provider_for_user({
|
909
|
+
# user_pool_id: "StringType", # required
|
910
|
+
# destination_user: { # required
|
911
|
+
# provider_name: "ProviderNameType",
|
912
|
+
# provider_attribute_name: "StringType",
|
913
|
+
# provider_attribute_value: "StringType",
|
914
|
+
# },
|
915
|
+
# source_user: { # required
|
916
|
+
# provider_name: "ProviderNameType",
|
917
|
+
# provider_attribute_name: "StringType",
|
918
|
+
# provider_attribute_value: "StringType",
|
919
|
+
# },
|
920
|
+
# })
|
921
|
+
#
|
922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminLinkProviderForUser AWS API Documentation
|
923
|
+
#
|
924
|
+
# @overload admin_link_provider_for_user(params = {})
|
925
|
+
# @param [Hash] params ({})
|
926
|
+
def admin_link_provider_for_user(params = {}, options = {})
|
927
|
+
req = build_request(:admin_link_provider_for_user, params)
|
928
|
+
req.send_request(options)
|
929
|
+
end
|
930
|
+
|
775
931
|
# Lists devices, as an administrator.
|
776
932
|
#
|
777
933
|
# Requires developer credentials.
|
@@ -1266,7 +1422,7 @@ module Aws::CognitoIdentityProvider
|
|
1266
1422
|
# password.
|
1267
1423
|
#
|
1268
1424
|
# @option params [required, String] :client_id
|
1269
|
-
# The ID of the
|
1425
|
+
# The app client ID of the app associated with the user pool.
|
1270
1426
|
#
|
1271
1427
|
# @option params [String] :secret_hash
|
1272
1428
|
# A keyed-hash message authentication code (HMAC) calculated using the
|
@@ -1311,7 +1467,7 @@ module Aws::CognitoIdentityProvider
|
|
1311
1467
|
# previous user.
|
1312
1468
|
#
|
1313
1469
|
# @option params [required, String] :client_id
|
1314
|
-
# The ID of the client associated with the user pool.
|
1470
|
+
# The ID of the app client associated with the user pool.
|
1315
1471
|
#
|
1316
1472
|
# @option params [String] :secret_hash
|
1317
1473
|
# A keyed-hash message authentication code (HMAC) calculated using the
|
@@ -1453,13 +1609,13 @@ module Aws::CognitoIdentityProvider
|
|
1453
1609
|
#
|
1454
1610
|
# resp = client.create_identity_provider({
|
1455
1611
|
# user_pool_id: "UserPoolIdType", # required
|
1456
|
-
# provider_name: "
|
1457
|
-
# provider_type: "SAML", # required, accepts SAML
|
1612
|
+
# provider_name: "ProviderNameTypeV1", # required
|
1613
|
+
# provider_type: "SAML", # required, accepts SAML, Facebook, Google, LoginWithAmazon
|
1458
1614
|
# provider_details: { # required
|
1459
1615
|
# "StringType" => "StringType",
|
1460
1616
|
# },
|
1461
1617
|
# attribute_mapping: {
|
1462
|
-
# "
|
1618
|
+
# "AttributeMappingKeyType" => "StringType",
|
1463
1619
|
# },
|
1464
1620
|
# idp_identifiers: ["IdpIdentifierType"],
|
1465
1621
|
# })
|
@@ -1468,11 +1624,11 @@ module Aws::CognitoIdentityProvider
|
|
1468
1624
|
#
|
1469
1625
|
# resp.identity_provider.user_pool_id #=> String
|
1470
1626
|
# resp.identity_provider.provider_name #=> String
|
1471
|
-
# resp.identity_provider.provider_type #=> String, one of "SAML"
|
1627
|
+
# resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon"
|
1472
1628
|
# resp.identity_provider.provider_details #=> Hash
|
1473
1629
|
# resp.identity_provider.provider_details["StringType"] #=> String
|
1474
1630
|
# resp.identity_provider.attribute_mapping #=> Hash
|
1475
|
-
# resp.identity_provider.attribute_mapping["
|
1631
|
+
# resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
|
1476
1632
|
# resp.identity_provider.idp_identifiers #=> Array
|
1477
1633
|
# resp.identity_provider.idp_identifiers[0] #=> String
|
1478
1634
|
# resp.identity_provider.last_modified_date #=> Time
|
@@ -1487,6 +1643,60 @@ module Aws::CognitoIdentityProvider
|
|
1487
1643
|
req.send_request(options)
|
1488
1644
|
end
|
1489
1645
|
|
1646
|
+
# Creates a new OAuth2.0 resource server and defines custom scopes in
|
1647
|
+
# it.
|
1648
|
+
#
|
1649
|
+
# @option params [required, String] :user_pool_id
|
1650
|
+
# The user pool ID for the user pool.
|
1651
|
+
#
|
1652
|
+
# @option params [required, String] :identifier
|
1653
|
+
# A unique resource server identifier for the resource server. This
|
1654
|
+
# could be an HTTPS endpoint where the resource server is located. For
|
1655
|
+
# example, `https://my-weather-api.example.com`.
|
1656
|
+
#
|
1657
|
+
# @option params [required, String] :name
|
1658
|
+
# A friendly name for the resource server.
|
1659
|
+
#
|
1660
|
+
# @option params [Array<Types::ResourceServerScopeType>] :scopes
|
1661
|
+
# A list of scopes. Each scope is map, where the keys are `name` and
|
1662
|
+
# `description`.
|
1663
|
+
#
|
1664
|
+
# @return [Types::CreateResourceServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1665
|
+
#
|
1666
|
+
# * {Types::CreateResourceServerResponse#resource_server #resource_server} => Types::ResourceServerType
|
1667
|
+
#
|
1668
|
+
# @example Request syntax with placeholder values
|
1669
|
+
#
|
1670
|
+
# resp = client.create_resource_server({
|
1671
|
+
# user_pool_id: "UserPoolIdType", # required
|
1672
|
+
# identifier: "ResourceServerIdentifierType", # required
|
1673
|
+
# name: "ResourceServerNameType", # required
|
1674
|
+
# scopes: [
|
1675
|
+
# {
|
1676
|
+
# scope_name: "ResourceServerScopeNameType", # required
|
1677
|
+
# scope_description: "ResourceServerScopeDescriptionType", # required
|
1678
|
+
# },
|
1679
|
+
# ],
|
1680
|
+
# })
|
1681
|
+
#
|
1682
|
+
# @example Response structure
|
1683
|
+
#
|
1684
|
+
# resp.resource_server.user_pool_id #=> String
|
1685
|
+
# resp.resource_server.identifier #=> String
|
1686
|
+
# resp.resource_server.name #=> String
|
1687
|
+
# resp.resource_server.scopes #=> Array
|
1688
|
+
# resp.resource_server.scopes[0].scope_name #=> String
|
1689
|
+
# resp.resource_server.scopes[0].scope_description #=> String
|
1690
|
+
#
|
1691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateResourceServer AWS API Documentation
|
1692
|
+
#
|
1693
|
+
# @overload create_resource_server(params = {})
|
1694
|
+
# @param [Hash] params ({})
|
1695
|
+
def create_resource_server(params = {}, options = {})
|
1696
|
+
req = build_request(:create_resource_server, params)
|
1697
|
+
req.send_request(options)
|
1698
|
+
end
|
1699
|
+
|
1490
1700
|
# Creates the user import job.
|
1491
1701
|
#
|
1492
1702
|
# @option params [required, String] :job_name
|
@@ -1570,6 +1780,10 @@ module Aws::CognitoIdentityProvider
|
|
1570
1780
|
# @option params [String] :email_verification_subject
|
1571
1781
|
# A string representing the email verification subject.
|
1572
1782
|
#
|
1783
|
+
# @option params [Types::VerificationMessageTemplateType] :verification_message_template
|
1784
|
+
# The template for the verification message that the user sees when the
|
1785
|
+
# app requests permission to access the user's information.
|
1786
|
+
#
|
1573
1787
|
# @option params [String] :sms_authentication_message
|
1574
1788
|
# A string representing the SMS authentication message.
|
1575
1789
|
#
|
@@ -1633,6 +1847,14 @@ module Aws::CognitoIdentityProvider
|
|
1633
1847
|
# sms_verification_message: "SmsVerificationMessageType",
|
1634
1848
|
# email_verification_message: "EmailVerificationMessageType",
|
1635
1849
|
# email_verification_subject: "EmailVerificationSubjectType",
|
1850
|
+
# verification_message_template: {
|
1851
|
+
# sms_message: "SmsVerificationMessageType",
|
1852
|
+
# email_message: "EmailVerificationMessageType",
|
1853
|
+
# email_subject: "EmailVerificationSubjectType",
|
1854
|
+
# email_message_by_link: "EmailVerificationMessageByLinkType",
|
1855
|
+
# email_subject_by_link: "EmailVerificationSubjectByLinkType",
|
1856
|
+
# default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
|
1857
|
+
# },
|
1636
1858
|
# sms_authentication_message: "SmsVerificationMessageType",
|
1637
1859
|
# mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
|
1638
1860
|
# device_configuration: {
|
@@ -1717,6 +1939,12 @@ module Aws::CognitoIdentityProvider
|
|
1717
1939
|
# resp.user_pool.sms_verification_message #=> String
|
1718
1940
|
# resp.user_pool.email_verification_message #=> String
|
1719
1941
|
# resp.user_pool.email_verification_subject #=> String
|
1942
|
+
# resp.user_pool.verification_message_template.sms_message #=> String
|
1943
|
+
# resp.user_pool.verification_message_template.email_message #=> String
|
1944
|
+
# resp.user_pool.verification_message_template.email_subject #=> String
|
1945
|
+
# resp.user_pool.verification_message_template.email_message_by_link #=> String
|
1946
|
+
# resp.user_pool.verification_message_template.email_subject_by_link #=> String
|
1947
|
+
# resp.user_pool.verification_message_template.default_email_option #=> String, one of "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE"
|
1720
1948
|
# resp.user_pool.sms_authentication_message #=> String
|
1721
1949
|
# resp.user_pool.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
|
1722
1950
|
# resp.user_pool.device_configuration.challenge_required_on_new_device #=> Boolean
|
@@ -1940,7 +2168,33 @@ module Aws::CognitoIdentityProvider
|
|
1940
2168
|
req.send_request(options)
|
1941
2169
|
end
|
1942
2170
|
|
1943
|
-
#
|
2171
|
+
# Deletes a resource server.
|
2172
|
+
#
|
2173
|
+
# @option params [required, String] :user_pool_id
|
2174
|
+
# The user pool ID for the user pool that hosts the resource server.
|
2175
|
+
#
|
2176
|
+
# @option params [required, String] :identifier
|
2177
|
+
# The identifier for the resource server.
|
2178
|
+
#
|
2179
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2180
|
+
#
|
2181
|
+
# @example Request syntax with placeholder values
|
2182
|
+
#
|
2183
|
+
# resp = client.delete_resource_server({
|
2184
|
+
# user_pool_id: "UserPoolIdType", # required
|
2185
|
+
# identifier: "ResourceServerIdentifierType", # required
|
2186
|
+
# })
|
2187
|
+
#
|
2188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteResourceServer AWS API Documentation
|
2189
|
+
#
|
2190
|
+
# @overload delete_resource_server(params = {})
|
2191
|
+
# @param [Hash] params ({})
|
2192
|
+
def delete_resource_server(params = {}, options = {})
|
2193
|
+
req = build_request(:delete_resource_server, params)
|
2194
|
+
req.send_request(options)
|
2195
|
+
end
|
2196
|
+
|
2197
|
+
# Allows a user to delete himself or herself.
|
1944
2198
|
#
|
1945
2199
|
# @option params [required, String] :access_token
|
1946
2200
|
# The access token from a request to delete a user.
|
@@ -2021,7 +2275,7 @@ module Aws::CognitoIdentityProvider
|
|
2021
2275
|
# client.
|
2022
2276
|
#
|
2023
2277
|
# @option params [required, String] :client_id
|
2024
|
-
# The ID of the
|
2278
|
+
# The app client ID of the app associated with the user pool.
|
2025
2279
|
#
|
2026
2280
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2027
2281
|
#
|
@@ -2090,11 +2344,11 @@ module Aws::CognitoIdentityProvider
|
|
2090
2344
|
#
|
2091
2345
|
# resp.identity_provider.user_pool_id #=> String
|
2092
2346
|
# resp.identity_provider.provider_name #=> String
|
2093
|
-
# resp.identity_provider.provider_type #=> String, one of "SAML"
|
2347
|
+
# resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon"
|
2094
2348
|
# resp.identity_provider.provider_details #=> Hash
|
2095
2349
|
# resp.identity_provider.provider_details["StringType"] #=> String
|
2096
2350
|
# resp.identity_provider.attribute_mapping #=> Hash
|
2097
|
-
# resp.identity_provider.attribute_mapping["
|
2351
|
+
# resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
|
2098
2352
|
# resp.identity_provider.idp_identifiers #=> Array
|
2099
2353
|
# resp.identity_provider.idp_identifiers[0] #=> String
|
2100
2354
|
# resp.identity_provider.last_modified_date #=> Time
|
@@ -2109,6 +2363,43 @@ module Aws::CognitoIdentityProvider
|
|
2109
2363
|
req.send_request(options)
|
2110
2364
|
end
|
2111
2365
|
|
2366
|
+
# Describes a resource server.
|
2367
|
+
#
|
2368
|
+
# @option params [required, String] :user_pool_id
|
2369
|
+
# The user pool ID for the user pool that hosts the resource server.
|
2370
|
+
#
|
2371
|
+
# @option params [required, String] :identifier
|
2372
|
+
# The identifier for the resource server
|
2373
|
+
#
|
2374
|
+
# @return [Types::DescribeResourceServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2375
|
+
#
|
2376
|
+
# * {Types::DescribeResourceServerResponse#resource_server #resource_server} => Types::ResourceServerType
|
2377
|
+
#
|
2378
|
+
# @example Request syntax with placeholder values
|
2379
|
+
#
|
2380
|
+
# resp = client.describe_resource_server({
|
2381
|
+
# user_pool_id: "UserPoolIdType", # required
|
2382
|
+
# identifier: "ResourceServerIdentifierType", # required
|
2383
|
+
# })
|
2384
|
+
#
|
2385
|
+
# @example Response structure
|
2386
|
+
#
|
2387
|
+
# resp.resource_server.user_pool_id #=> String
|
2388
|
+
# resp.resource_server.identifier #=> String
|
2389
|
+
# resp.resource_server.name #=> String
|
2390
|
+
# resp.resource_server.scopes #=> Array
|
2391
|
+
# resp.resource_server.scopes[0].scope_name #=> String
|
2392
|
+
# resp.resource_server.scopes[0].scope_description #=> String
|
2393
|
+
#
|
2394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeResourceServer AWS API Documentation
|
2395
|
+
#
|
2396
|
+
# @overload describe_resource_server(params = {})
|
2397
|
+
# @param [Hash] params ({})
|
2398
|
+
def describe_resource_server(params = {}, options = {})
|
2399
|
+
req = build_request(:describe_resource_server, params)
|
2400
|
+
req.send_request(options)
|
2401
|
+
end
|
2402
|
+
|
2112
2403
|
# Describes the user import job.
|
2113
2404
|
#
|
2114
2405
|
# @option params [required, String] :user_pool_id
|
@@ -2209,6 +2500,12 @@ module Aws::CognitoIdentityProvider
|
|
2209
2500
|
# resp.user_pool.sms_verification_message #=> String
|
2210
2501
|
# resp.user_pool.email_verification_message #=> String
|
2211
2502
|
# resp.user_pool.email_verification_subject #=> String
|
2503
|
+
# resp.user_pool.verification_message_template.sms_message #=> String
|
2504
|
+
# resp.user_pool.verification_message_template.email_message #=> String
|
2505
|
+
# resp.user_pool.verification_message_template.email_subject #=> String
|
2506
|
+
# resp.user_pool.verification_message_template.email_message_by_link #=> String
|
2507
|
+
# resp.user_pool.verification_message_template.email_subject_by_link #=> String
|
2508
|
+
# resp.user_pool.verification_message_template.default_email_option #=> String, one of "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE"
|
2212
2509
|
# resp.user_pool.sms_authentication_message #=> String
|
2213
2510
|
# resp.user_pool.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
|
2214
2511
|
# resp.user_pool.device_configuration.challenge_required_on_new_device #=> Boolean
|
@@ -2244,7 +2541,7 @@ module Aws::CognitoIdentityProvider
|
|
2244
2541
|
# The user pool ID for the user pool you want to describe.
|
2245
2542
|
#
|
2246
2543
|
# @option params [required, String] :client_id
|
2247
|
-
# The ID of the
|
2544
|
+
# The app client ID of the app associated with the user pool.
|
2248
2545
|
#
|
2249
2546
|
# @return [Types::DescribeUserPoolClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2250
2547
|
#
|
@@ -2317,7 +2614,7 @@ module Aws::CognitoIdentityProvider
|
|
2317
2614
|
# resp.domain_description.s3_bucket #=> String
|
2318
2615
|
# resp.domain_description.cloud_front_distribution #=> String
|
2319
2616
|
# resp.domain_description.version #=> String
|
2320
|
-
# resp.domain_description.status #=> String, one of "CREATING", "DELETING", "UPDATING", "ACTIVE"
|
2617
|
+
# resp.domain_description.status #=> String, one of "CREATING", "DELETING", "UPDATING", "ACTIVE", "FAILED"
|
2321
2618
|
#
|
2322
2619
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolDomain AWS API Documentation
|
2323
2620
|
#
|
@@ -2537,11 +2834,11 @@ module Aws::CognitoIdentityProvider
|
|
2537
2834
|
#
|
2538
2835
|
# resp.identity_provider.user_pool_id #=> String
|
2539
2836
|
# resp.identity_provider.provider_name #=> String
|
2540
|
-
# resp.identity_provider.provider_type #=> String, one of "SAML"
|
2837
|
+
# resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon"
|
2541
2838
|
# resp.identity_provider.provider_details #=> Hash
|
2542
2839
|
# resp.identity_provider.provider_details["StringType"] #=> String
|
2543
2840
|
# resp.identity_provider.attribute_mapping #=> Hash
|
2544
|
-
# resp.identity_provider.attribute_mapping["
|
2841
|
+
# resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
|
2545
2842
|
# resp.identity_provider.idp_identifiers #=> Array
|
2546
2843
|
# resp.identity_provider.idp_identifiers[0] #=> String
|
2547
2844
|
# resp.identity_provider.last_modified_date #=> Time
|
@@ -2556,6 +2853,48 @@ module Aws::CognitoIdentityProvider
|
|
2556
2853
|
req.send_request(options)
|
2557
2854
|
end
|
2558
2855
|
|
2856
|
+
# Gets the UI Customization information for a particular app client's
|
2857
|
+
# app UI, if there is something set. If nothing is set for the
|
2858
|
+
# particular client, but there is an existing pool level customization
|
2859
|
+
# (app `clientId` will be `ALL`), then that is returned. If nothing is
|
2860
|
+
# present, then an empty shape is returned.
|
2861
|
+
#
|
2862
|
+
# @option params [required, String] :user_pool_id
|
2863
|
+
# The user pool ID for the user pool.
|
2864
|
+
#
|
2865
|
+
# @option params [String] :client_id
|
2866
|
+
# The client ID for the client app.
|
2867
|
+
#
|
2868
|
+
# @return [Types::GetUICustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2869
|
+
#
|
2870
|
+
# * {Types::GetUICustomizationResponse#ui_customization #ui_customization} => Types::UICustomizationType
|
2871
|
+
#
|
2872
|
+
# @example Request syntax with placeholder values
|
2873
|
+
#
|
2874
|
+
# resp = client.get_ui_customization({
|
2875
|
+
# user_pool_id: "UserPoolIdType", # required
|
2876
|
+
# client_id: "ClientIdType",
|
2877
|
+
# })
|
2878
|
+
#
|
2879
|
+
# @example Response structure
|
2880
|
+
#
|
2881
|
+
# resp.ui_customization.user_pool_id #=> String
|
2882
|
+
# resp.ui_customization.client_id #=> String
|
2883
|
+
# resp.ui_customization.image_url #=> String
|
2884
|
+
# resp.ui_customization.css #=> String
|
2885
|
+
# resp.ui_customization.css_version #=> String
|
2886
|
+
# resp.ui_customization.last_modified_date #=> Time
|
2887
|
+
# resp.ui_customization.creation_date #=> Time
|
2888
|
+
#
|
2889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUICustomization AWS API Documentation
|
2890
|
+
#
|
2891
|
+
# @overload get_ui_customization(params = {})
|
2892
|
+
# @param [Hash] params ({})
|
2893
|
+
def get_ui_customization(params = {}, options = {})
|
2894
|
+
req = build_request(:get_ui_customization, params)
|
2895
|
+
req.send_request(options)
|
2896
|
+
end
|
2897
|
+
|
2559
2898
|
# Gets the user attributes and metadata for a user.
|
2560
2899
|
#
|
2561
2900
|
# @option params [required, String] :access_token
|
@@ -2866,7 +3205,7 @@ module Aws::CognitoIdentityProvider
|
|
2866
3205
|
#
|
2867
3206
|
# resp.providers #=> Array
|
2868
3207
|
# resp.providers[0].provider_name #=> String
|
2869
|
-
# resp.providers[0].provider_type #=> String, one of "SAML"
|
3208
|
+
# resp.providers[0].provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon"
|
2870
3209
|
# resp.providers[0].last_modified_date #=> Time
|
2871
3210
|
# resp.providers[0].creation_date #=> Time
|
2872
3211
|
# resp.next_token #=> String
|
@@ -2880,6 +3219,50 @@ module Aws::CognitoIdentityProvider
|
|
2880
3219
|
req.send_request(options)
|
2881
3220
|
end
|
2882
3221
|
|
3222
|
+
# Lists the resource servers for a user pool.
|
3223
|
+
#
|
3224
|
+
# @option params [required, String] :user_pool_id
|
3225
|
+
# The user pool ID for the user pool.
|
3226
|
+
#
|
3227
|
+
# @option params [Integer] :max_results
|
3228
|
+
# The maximum number of resource servers to return.
|
3229
|
+
#
|
3230
|
+
# @option params [String] :next_token
|
3231
|
+
# A pagination token.
|
3232
|
+
#
|
3233
|
+
# @return [Types::ListResourceServersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3234
|
+
#
|
3235
|
+
# * {Types::ListResourceServersResponse#resource_servers #resource_servers} => Array<Types::ResourceServerType>
|
3236
|
+
# * {Types::ListResourceServersResponse#next_token #next_token} => String
|
3237
|
+
#
|
3238
|
+
# @example Request syntax with placeholder values
|
3239
|
+
#
|
3240
|
+
# resp = client.list_resource_servers({
|
3241
|
+
# user_pool_id: "UserPoolIdType", # required
|
3242
|
+
# max_results: 1,
|
3243
|
+
# next_token: "PaginationKeyType",
|
3244
|
+
# })
|
3245
|
+
#
|
3246
|
+
# @example Response structure
|
3247
|
+
#
|
3248
|
+
# resp.resource_servers #=> Array
|
3249
|
+
# resp.resource_servers[0].user_pool_id #=> String
|
3250
|
+
# resp.resource_servers[0].identifier #=> String
|
3251
|
+
# resp.resource_servers[0].name #=> String
|
3252
|
+
# resp.resource_servers[0].scopes #=> Array
|
3253
|
+
# resp.resource_servers[0].scopes[0].scope_name #=> String
|
3254
|
+
# resp.resource_servers[0].scopes[0].scope_description #=> String
|
3255
|
+
# resp.next_token #=> String
|
3256
|
+
#
|
3257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListResourceServers AWS API Documentation
|
3258
|
+
#
|
3259
|
+
# @overload list_resource_servers(params = {})
|
3260
|
+
# @param [Hash] params ({})
|
3261
|
+
def list_resource_servers(params = {}, options = {})
|
3262
|
+
req = build_request(:list_resource_servers, params)
|
3263
|
+
req.send_request(options)
|
3264
|
+
end
|
3265
|
+
|
2883
3266
|
# Lists the user import jobs.
|
2884
3267
|
#
|
2885
3268
|
# @option params [required, String] :user_pool_id
|
@@ -3313,6 +3696,66 @@ module Aws::CognitoIdentityProvider
|
|
3313
3696
|
req.send_request(options)
|
3314
3697
|
end
|
3315
3698
|
|
3699
|
+
# Sets the UI customization information for a user pool's built-in app
|
3700
|
+
# UI.
|
3701
|
+
#
|
3702
|
+
# You can specify app UI customization settings for a single client
|
3703
|
+
# (with a specific `clientId`) or for all clients (by setting the
|
3704
|
+
# `clientId` to `ALL`). If you specify `ALL`, the default configuration
|
3705
|
+
# will be used for every client that has no UI customization set
|
3706
|
+
# previously. If you specify UI customization settings for a particular
|
3707
|
+
# client, it will no longer fall back to the `ALL` configuration.
|
3708
|
+
#
|
3709
|
+
# <note markdown="1"> To use this API, your user pool must have a domain associated with it.
|
3710
|
+
# Otherwise, there is no place to host the app's pages, and the service
|
3711
|
+
# will throw an error.
|
3712
|
+
#
|
3713
|
+
# </note>
|
3714
|
+
#
|
3715
|
+
# @option params [required, String] :user_pool_id
|
3716
|
+
# The user pool ID for the user pool.
|
3717
|
+
#
|
3718
|
+
# @option params [String] :client_id
|
3719
|
+
# The client ID for the client app.
|
3720
|
+
#
|
3721
|
+
# @option params [String] :css
|
3722
|
+
# The CSS values in the UI customization.
|
3723
|
+
#
|
3724
|
+
# @option params [String, IO] :image_file
|
3725
|
+
# The uploaded logo image for the UI customization.
|
3726
|
+
#
|
3727
|
+
# @return [Types::SetUICustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3728
|
+
#
|
3729
|
+
# * {Types::SetUICustomizationResponse#ui_customization #ui_customization} => Types::UICustomizationType
|
3730
|
+
#
|
3731
|
+
# @example Request syntax with placeholder values
|
3732
|
+
#
|
3733
|
+
# resp = client.set_ui_customization({
|
3734
|
+
# user_pool_id: "UserPoolIdType", # required
|
3735
|
+
# client_id: "ClientIdType",
|
3736
|
+
# css: "CSSType",
|
3737
|
+
# image_file: "data",
|
3738
|
+
# })
|
3739
|
+
#
|
3740
|
+
# @example Response structure
|
3741
|
+
#
|
3742
|
+
# resp.ui_customization.user_pool_id #=> String
|
3743
|
+
# resp.ui_customization.client_id #=> String
|
3744
|
+
# resp.ui_customization.image_url #=> String
|
3745
|
+
# resp.ui_customization.css #=> String
|
3746
|
+
# resp.ui_customization.css_version #=> String
|
3747
|
+
# resp.ui_customization.last_modified_date #=> Time
|
3748
|
+
# resp.ui_customization.creation_date #=> Time
|
3749
|
+
#
|
3750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUICustomization AWS API Documentation
|
3751
|
+
#
|
3752
|
+
# @overload set_ui_customization(params = {})
|
3753
|
+
# @param [Hash] params ({})
|
3754
|
+
def set_ui_customization(params = {}, options = {})
|
3755
|
+
req = build_request(:set_ui_customization, params)
|
3756
|
+
req.send_request(options)
|
3757
|
+
end
|
3758
|
+
|
3316
3759
|
# Sets the user settings like multi-factor authentication (MFA). If MFA
|
3317
3760
|
# is to be removed for a particular attribute pass the attribute with
|
3318
3761
|
# code delivery as null. If null list is passed, all MFA options are
|
@@ -3622,7 +4065,7 @@ module Aws::CognitoIdentityProvider
|
|
3622
4065
|
# "StringType" => "StringType",
|
3623
4066
|
# },
|
3624
4067
|
# attribute_mapping: {
|
3625
|
-
# "
|
4068
|
+
# "AttributeMappingKeyType" => "StringType",
|
3626
4069
|
# },
|
3627
4070
|
# idp_identifiers: ["IdpIdentifierType"],
|
3628
4071
|
# })
|
@@ -3631,11 +4074,11 @@ module Aws::CognitoIdentityProvider
|
|
3631
4074
|
#
|
3632
4075
|
# resp.identity_provider.user_pool_id #=> String
|
3633
4076
|
# resp.identity_provider.provider_name #=> String
|
3634
|
-
# resp.identity_provider.provider_type #=> String, one of "SAML"
|
4077
|
+
# resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon"
|
3635
4078
|
# resp.identity_provider.provider_details #=> Hash
|
3636
4079
|
# resp.identity_provider.provider_details["StringType"] #=> String
|
3637
4080
|
# resp.identity_provider.attribute_mapping #=> Hash
|
3638
|
-
# resp.identity_provider.attribute_mapping["
|
4081
|
+
# resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
|
3639
4082
|
# resp.identity_provider.idp_identifiers #=> Array
|
3640
4083
|
# resp.identity_provider.idp_identifiers[0] #=> String
|
3641
4084
|
# resp.identity_provider.last_modified_date #=> Time
|
@@ -3650,6 +4093,57 @@ module Aws::CognitoIdentityProvider
|
|
3650
4093
|
req.send_request(options)
|
3651
4094
|
end
|
3652
4095
|
|
4096
|
+
# Updates the name and scopes of resource server. All other fields are
|
4097
|
+
# read-only.
|
4098
|
+
#
|
4099
|
+
# @option params [required, String] :user_pool_id
|
4100
|
+
# The user pool ID for the user pool.
|
4101
|
+
#
|
4102
|
+
# @option params [required, String] :identifier
|
4103
|
+
# The identifier for the resource server.
|
4104
|
+
#
|
4105
|
+
# @option params [required, String] :name
|
4106
|
+
# The name of the resource server.
|
4107
|
+
#
|
4108
|
+
# @option params [Array<Types::ResourceServerScopeType>] :scopes
|
4109
|
+
# The scope values to be set for the resource server.
|
4110
|
+
#
|
4111
|
+
# @return [Types::UpdateResourceServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4112
|
+
#
|
4113
|
+
# * {Types::UpdateResourceServerResponse#resource_server #resource_server} => Types::ResourceServerType
|
4114
|
+
#
|
4115
|
+
# @example Request syntax with placeholder values
|
4116
|
+
#
|
4117
|
+
# resp = client.update_resource_server({
|
4118
|
+
# user_pool_id: "UserPoolIdType", # required
|
4119
|
+
# identifier: "ResourceServerIdentifierType", # required
|
4120
|
+
# name: "ResourceServerNameType", # required
|
4121
|
+
# scopes: [
|
4122
|
+
# {
|
4123
|
+
# scope_name: "ResourceServerScopeNameType", # required
|
4124
|
+
# scope_description: "ResourceServerScopeDescriptionType", # required
|
4125
|
+
# },
|
4126
|
+
# ],
|
4127
|
+
# })
|
4128
|
+
#
|
4129
|
+
# @example Response structure
|
4130
|
+
#
|
4131
|
+
# resp.resource_server.user_pool_id #=> String
|
4132
|
+
# resp.resource_server.identifier #=> String
|
4133
|
+
# resp.resource_server.name #=> String
|
4134
|
+
# resp.resource_server.scopes #=> Array
|
4135
|
+
# resp.resource_server.scopes[0].scope_name #=> String
|
4136
|
+
# resp.resource_server.scopes[0].scope_description #=> String
|
4137
|
+
#
|
4138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateResourceServer AWS API Documentation
|
4139
|
+
#
|
4140
|
+
# @overload update_resource_server(params = {})
|
4141
|
+
# @param [Hash] params ({})
|
4142
|
+
def update_resource_server(params = {}, options = {})
|
4143
|
+
req = build_request(:update_resource_server, params)
|
4144
|
+
req.send_request(options)
|
4145
|
+
end
|
4146
|
+
|
3653
4147
|
# Allows a user to update a specific attribute (one at a time).
|
3654
4148
|
#
|
3655
4149
|
# @option params [required, Array<Types::AttributeType>] :user_attributes
|
@@ -3718,6 +4212,9 @@ module Aws::CognitoIdentityProvider
|
|
3718
4212
|
# @option params [String] :email_verification_subject
|
3719
4213
|
# The subject of the email verification message.
|
3720
4214
|
#
|
4215
|
+
# @option params [Types::VerificationMessageTemplateType] :verification_message_template
|
4216
|
+
# The template for verification messages.
|
4217
|
+
#
|
3721
4218
|
# @option params [String] :sms_authentication_message
|
3722
4219
|
# The contents of the SMS authentication message.
|
3723
4220
|
#
|
@@ -3782,6 +4279,14 @@ module Aws::CognitoIdentityProvider
|
|
3782
4279
|
# sms_verification_message: "SmsVerificationMessageType",
|
3783
4280
|
# email_verification_message: "EmailVerificationMessageType",
|
3784
4281
|
# email_verification_subject: "EmailVerificationSubjectType",
|
4282
|
+
# verification_message_template: {
|
4283
|
+
# sms_message: "SmsVerificationMessageType",
|
4284
|
+
# email_message: "EmailVerificationMessageType",
|
4285
|
+
# email_subject: "EmailVerificationSubjectType",
|
4286
|
+
# email_message_by_link: "EmailVerificationMessageByLinkType",
|
4287
|
+
# email_subject_by_link: "EmailVerificationSubjectByLinkType",
|
4288
|
+
# default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
|
4289
|
+
# },
|
3785
4290
|
# sms_authentication_message: "SmsVerificationMessageType",
|
3786
4291
|
# mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
|
3787
4292
|
# device_configuration: {
|
@@ -3853,7 +4358,7 @@ module Aws::CognitoIdentityProvider
|
|
3853
4358
|
# A list of allowed callback URLs for the identity providers.
|
3854
4359
|
#
|
3855
4360
|
# @option params [Array<String>] :logout_urls
|
3856
|
-
# A list
|
4361
|
+
# A list of allowed logout URLs for the identity providers.
|
3857
4362
|
#
|
3858
4363
|
# @option params [String] :default_redirect_uri
|
3859
4364
|
# The default redirect URI. Must be in the `CallbackURLs` list.
|
@@ -3977,7 +4482,7 @@ module Aws::CognitoIdentityProvider
|
|
3977
4482
|
params: params,
|
3978
4483
|
config: config)
|
3979
4484
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
3980
|
-
context[:gem_version] = '1.0.0.
|
4485
|
+
context[:gem_version] = '1.0.0.rc13'
|
3981
4486
|
Seahorse::Client::Request.new(handlers, context)
|
3982
4487
|
end
|
3983
4488
|
|