aws-sdk-cognitoidentityprovider 1.164.0 → 1.166.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cognitoidentityprovider/client.rb +294 -6
- data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +69 -0
- data/lib/aws-sdk-cognitoidentityprovider/types.rb +380 -3
- data/lib/aws-sdk-cognitoidentityprovider.rb +1 -1
- data/sig/client.rbs +43 -3
- data/sig/types.rbs +43 -3
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6754218580b3c0781ad19e318e3c53550eddca40954923e243340ec8a3965d01
|
|
4
|
+
data.tar.gz: 1ab912085bdc64dae79f0499eed99540415ecb51f7f2b963fff80d096effcfac
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 95315a76f07d3fe73f340afde5d8c0753cf2d13c39d5e1e252fd01e07382af1e45b4234c8888502c11fdf184d517985b460a0ffd1bacbabfb31f772ddbf08f56
|
|
7
|
+
data.tar.gz: 42608c40e619571d628567d6ed120c6ecee82581e2a44522f89329cd99036e58238f8da00f00e5e2ed0690ad382c733c75eacd466f876f07368c6b1aa87e7020
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.166.0 (2026-11-16)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Implement OAuth 2.0 Token Exchange (RFC 8693) for Cognito User Pools, enabling services to exchange a user's existing token for a new token that is appropriately scoped and audience-bound for a specific downstream service.
|
|
8
|
+
|
|
9
|
+
1.165.0 (2026-11-13)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Adding support for dynamic client registration.
|
|
13
|
+
|
|
4
14
|
1.164.0 (2026-11-11)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.166.0
|
|
@@ -4906,6 +4906,7 @@ module Aws::CognitoIdentityProvider
|
|
|
4906
4906
|
# resp.resource_server.scopes #=> Array
|
|
4907
4907
|
# resp.resource_server.scopes[0].scope_name #=> String
|
|
4908
4908
|
# resp.resource_server.scopes[0].scope_description #=> String
|
|
4909
|
+
# resp.resource_server.managed_by #=> String, one of "COGNITO"
|
|
4909
4910
|
#
|
|
4910
4911
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateResourceServer AWS API Documentation
|
|
4911
4912
|
#
|
|
@@ -5341,6 +5342,17 @@ module Aws::CognitoIdentityProvider
|
|
|
5341
5342
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
|
|
5342
5343
|
# [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html
|
|
5343
5344
|
#
|
|
5345
|
+
# @option params [Types::DcrConfigurationType] :dcr_configuration
|
|
5346
|
+
# The dynamic client registration configuration for the user pool. With
|
|
5347
|
+
# dynamic client registration, applications can register their own app
|
|
5348
|
+
# clients at runtime through the registration endpoint of your user pool
|
|
5349
|
+
# domain. To activate this setting, your user pool must be in the [
|
|
5350
|
+
# Essentials tier][1] or higher.
|
|
5351
|
+
#
|
|
5352
|
+
#
|
|
5353
|
+
#
|
|
5354
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
|
|
5355
|
+
#
|
|
5344
5356
|
# @option params [Types::UsernameConfigurationType] :username_configuration
|
|
5345
5357
|
# Sets the case sensitivity option for sign-in usernames. When
|
|
5346
5358
|
# `CaseSensitive` is `false` (case insensitive), users can sign in with
|
|
@@ -6009,6 +6021,13 @@ module Aws::CognitoIdentityProvider
|
|
|
6009
6021
|
# custom_auth_mode: "AUDIT", # accepts AUDIT, ENFORCED
|
|
6010
6022
|
# },
|
|
6011
6023
|
# },
|
|
6024
|
+
# dcr_configuration: {
|
|
6025
|
+
# enable_status: "Enabled", # accepts Enabled, Disabled
|
|
6026
|
+
# open_dcr_enabled: false,
|
|
6027
|
+
# authenticated_grant_types: ["code"], # accepts code, implicit, client_credentials
|
|
6028
|
+
# open_dcr_grant_types: ["code"], # accepts code, implicit, client_credentials
|
|
6029
|
+
# allowed_scopes: ["ScopeType"],
|
|
6030
|
+
# },
|
|
6012
6031
|
# username_configuration: {
|
|
6013
6032
|
# case_sensitive: false, # required
|
|
6014
6033
|
# },
|
|
@@ -6131,6 +6150,14 @@ module Aws::CognitoIdentityProvider
|
|
|
6131
6150
|
# resp.user_pool.admin_create_user_config.invite_message_template.email_subject #=> String
|
|
6132
6151
|
# resp.user_pool.user_pool_add_ons.advanced_security_mode #=> String, one of "OFF", "AUDIT", "ENFORCED"
|
|
6133
6152
|
# resp.user_pool.user_pool_add_ons.advanced_security_additional_flows.custom_auth_mode #=> String, one of "AUDIT", "ENFORCED"
|
|
6153
|
+
# resp.user_pool.dcr_configuration.enable_status #=> String, one of "Enabled", "Disabled"
|
|
6154
|
+
# resp.user_pool.dcr_configuration.open_dcr_enabled #=> Boolean
|
|
6155
|
+
# resp.user_pool.dcr_configuration.authenticated_grant_types #=> Array
|
|
6156
|
+
# resp.user_pool.dcr_configuration.authenticated_grant_types[0] #=> String, one of "code", "implicit", "client_credentials"
|
|
6157
|
+
# resp.user_pool.dcr_configuration.open_dcr_grant_types #=> Array
|
|
6158
|
+
# resp.user_pool.dcr_configuration.open_dcr_grant_types[0] #=> String, one of "code", "implicit", "client_credentials"
|
|
6159
|
+
# resp.user_pool.dcr_configuration.allowed_scopes #=> Array
|
|
6160
|
+
# resp.user_pool.dcr_configuration.allowed_scopes[0] #=> String
|
|
6134
6161
|
# resp.user_pool.username_configuration.case_sensitive #=> Boolean
|
|
6135
6162
|
# resp.user_pool.arn #=> String
|
|
6136
6163
|
# resp.user_pool.account_recovery_setting.recovery_mechanisms #=> Array
|
|
@@ -6342,6 +6369,15 @@ module Aws::CognitoIdentityProvider
|
|
|
6342
6369
|
#
|
|
6343
6370
|
# * `ALLOW_REFRESH_TOKEN_AUTH`: Enable authflow to refresh tokens.
|
|
6344
6371
|
#
|
|
6372
|
+
# * `ALLOW_TOKEN_EXCHANGE_IMPERSONATION` – Use this flow to request
|
|
6373
|
+
# `GetDerivedToken` token exchanges without an `ActorToken`. The
|
|
6374
|
+
# issued token represents the subject user directly.
|
|
6375
|
+
#
|
|
6376
|
+
# * `ALLOW_TOKEN_EXCHANGE_DELEGATION` – Use this flow to request
|
|
6377
|
+
# `GetDerivedToken` token exchanges that include an `ActorToken`. The
|
|
6378
|
+
# issued token carries an `act` claim that identifies the intermediary
|
|
6379
|
+
# acting on the behalf of the subject.
|
|
6380
|
+
#
|
|
6345
6381
|
# In some environments, you will see the values `ADMIN_NO_SRP_AUTH`,
|
|
6346
6382
|
# `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign
|
|
6347
6383
|
# these legacy `ExplicitAuthFlows` values to user pool clients at the
|
|
@@ -6694,7 +6730,7 @@ module Aws::CognitoIdentityProvider
|
|
|
6694
6730
|
# },
|
|
6695
6731
|
# read_attributes: ["ClientPermissionType"],
|
|
6696
6732
|
# write_attributes: ["ClientPermissionType"],
|
|
6697
|
-
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_AUTH
|
|
6733
|
+
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_AUTH, ALLOW_TOKEN_EXCHANGE_DELEGATION, ALLOW_TOKEN_EXCHANGE_IMPERSONATION
|
|
6698
6734
|
# supported_identity_providers: ["ProviderNameType"],
|
|
6699
6735
|
# callback_urls: ["RedirectUrlType"],
|
|
6700
6736
|
# logout_urls: ["RedirectUrlType"],
|
|
@@ -6738,7 +6774,7 @@ module Aws::CognitoIdentityProvider
|
|
|
6738
6774
|
# resp.user_pool_client.write_attributes #=> Array
|
|
6739
6775
|
# resp.user_pool_client.write_attributes[0] #=> String
|
|
6740
6776
|
# resp.user_pool_client.explicit_auth_flows #=> Array
|
|
6741
|
-
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH", "ALLOW_USER_AUTH"
|
|
6777
|
+
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH", "ALLOW_USER_AUTH", "ALLOW_TOKEN_EXCHANGE_DELEGATION", "ALLOW_TOKEN_EXCHANGE_IMPERSONATION"
|
|
6742
6778
|
# resp.user_pool_client.supported_identity_providers #=> Array
|
|
6743
6779
|
# resp.user_pool_client.supported_identity_providers[0] #=> String
|
|
6744
6780
|
# resp.user_pool_client.callback_urls #=> Array
|
|
@@ -6762,6 +6798,7 @@ module Aws::CognitoIdentityProvider
|
|
|
6762
6798
|
# resp.user_pool_client.auth_session_validity #=> Integer
|
|
6763
6799
|
# resp.user_pool_client.refresh_token_rotation.feature #=> String, one of "ENABLED", "DISABLED"
|
|
6764
6800
|
# resp.user_pool_client.refresh_token_rotation.retry_grace_period_seconds #=> Integer
|
|
6801
|
+
# resp.user_pool_client.client_type #=> String, one of "REGULAR", "DCR"
|
|
6765
6802
|
#
|
|
6766
6803
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClient AWS API Documentation
|
|
6767
6804
|
#
|
|
@@ -7752,6 +7789,7 @@ module Aws::CognitoIdentityProvider
|
|
|
7752
7789
|
# resp.resource_server.scopes #=> Array
|
|
7753
7790
|
# resp.resource_server.scopes[0].scope_name #=> String
|
|
7754
7791
|
# resp.resource_server.scopes[0].scope_description #=> String
|
|
7792
|
+
# resp.resource_server.managed_by #=> String, one of "COGNITO"
|
|
7755
7793
|
#
|
|
7756
7794
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeResourceServer AWS API Documentation
|
|
7757
7795
|
#
|
|
@@ -8153,6 +8191,14 @@ module Aws::CognitoIdentityProvider
|
|
|
8153
8191
|
# resp.user_pool.admin_create_user_config.invite_message_template.email_subject #=> String
|
|
8154
8192
|
# resp.user_pool.user_pool_add_ons.advanced_security_mode #=> String, one of "OFF", "AUDIT", "ENFORCED"
|
|
8155
8193
|
# resp.user_pool.user_pool_add_ons.advanced_security_additional_flows.custom_auth_mode #=> String, one of "AUDIT", "ENFORCED"
|
|
8194
|
+
# resp.user_pool.dcr_configuration.enable_status #=> String, one of "Enabled", "Disabled"
|
|
8195
|
+
# resp.user_pool.dcr_configuration.open_dcr_enabled #=> Boolean
|
|
8196
|
+
# resp.user_pool.dcr_configuration.authenticated_grant_types #=> Array
|
|
8197
|
+
# resp.user_pool.dcr_configuration.authenticated_grant_types[0] #=> String, one of "code", "implicit", "client_credentials"
|
|
8198
|
+
# resp.user_pool.dcr_configuration.open_dcr_grant_types #=> Array
|
|
8199
|
+
# resp.user_pool.dcr_configuration.open_dcr_grant_types[0] #=> String, one of "code", "implicit", "client_credentials"
|
|
8200
|
+
# resp.user_pool.dcr_configuration.allowed_scopes #=> Array
|
|
8201
|
+
# resp.user_pool.dcr_configuration.allowed_scopes[0] #=> String
|
|
8156
8202
|
# resp.user_pool.username_configuration.case_sensitive #=> Boolean
|
|
8157
8203
|
# resp.user_pool.arn #=> String
|
|
8158
8204
|
# resp.user_pool.account_recovery_setting.recovery_mechanisms #=> Array
|
|
@@ -8235,7 +8281,7 @@ module Aws::CognitoIdentityProvider
|
|
|
8235
8281
|
# resp.user_pool_client.write_attributes #=> Array
|
|
8236
8282
|
# resp.user_pool_client.write_attributes[0] #=> String
|
|
8237
8283
|
# resp.user_pool_client.explicit_auth_flows #=> Array
|
|
8238
|
-
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH", "ALLOW_USER_AUTH"
|
|
8284
|
+
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH", "ALLOW_USER_AUTH", "ALLOW_TOKEN_EXCHANGE_DELEGATION", "ALLOW_TOKEN_EXCHANGE_IMPERSONATION"
|
|
8239
8285
|
# resp.user_pool_client.supported_identity_providers #=> Array
|
|
8240
8286
|
# resp.user_pool_client.supported_identity_providers[0] #=> String
|
|
8241
8287
|
# resp.user_pool_client.callback_urls #=> Array
|
|
@@ -8259,6 +8305,7 @@ module Aws::CognitoIdentityProvider
|
|
|
8259
8305
|
# resp.user_pool_client.auth_session_validity #=> Integer
|
|
8260
8306
|
# resp.user_pool_client.refresh_token_rotation.feature #=> String, one of "ENABLED", "DISABLED"
|
|
8261
8307
|
# resp.user_pool_client.refresh_token_rotation.retry_grace_period_seconds #=> Integer
|
|
8308
|
+
# resp.user_pool_client.client_type #=> String, one of "REGULAR", "DCR"
|
|
8262
8309
|
#
|
|
8263
8310
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClient AWS API Documentation
|
|
8264
8311
|
#
|
|
@@ -8730,6 +8777,187 @@ module Aws::CognitoIdentityProvider
|
|
|
8730
8777
|
req.send_request(options)
|
|
8731
8778
|
end
|
|
8732
8779
|
|
|
8780
|
+
# Exchanges an existing token for a new token that is scoped and
|
|
8781
|
+
# audience-bound for a specific downstream service, following the OAuth
|
|
8782
|
+
# 2.0 Token Exchange grant type. For more information about the OAuth
|
|
8783
|
+
# 2.0 Token Exchange grant type, see [RFC 8693 - OAuth 2.0 Token
|
|
8784
|
+
# Exchange][1] on the IETF website. Present a `SubjectToken`, the
|
|
8785
|
+
# credential that you already hold, to receive a new token appropriate
|
|
8786
|
+
# for calling a specific resource server or audience.
|
|
8787
|
+
#
|
|
8788
|
+
# If you also present an `ActorToken` that identifies an intermediary
|
|
8789
|
+
# service, the issued token carries an `act` claim that identifies the
|
|
8790
|
+
# intermediary, and downstream services can distinguish a user acting
|
|
8791
|
+
# directly from an intermediary acting on the user's behalf. If you
|
|
8792
|
+
# don't present an `ActorToken`, the issued token appears as if the
|
|
8793
|
+
# user acted directly.
|
|
8794
|
+
#
|
|
8795
|
+
# To use this operation, you must have IAM credentials, or you must
|
|
8796
|
+
# present the requesting app client's `ClientId` and, if the client has
|
|
8797
|
+
# a secret, `ClientSecret`, in the request.
|
|
8798
|
+
#
|
|
8799
|
+
# The requesting app client must have
|
|
8800
|
+
# `ALLOW_TOKEN_EXCHANGE_IMPERSONATION` or
|
|
8801
|
+
# `ALLOW_TOKEN_EXCHANGE_DELEGATION` in its `ExplicitAuthFlows`
|
|
8802
|
+
# (depending on whether you include an `ActorToken`), or the request
|
|
8803
|
+
# fails.
|
|
8804
|
+
#
|
|
8805
|
+
#
|
|
8806
|
+
#
|
|
8807
|
+
# [1]: https://tools.ietf.org/html/rfc8693
|
|
8808
|
+
#
|
|
8809
|
+
# @option params [required, String] :client_id
|
|
8810
|
+
# The ID of the app client that requests the token exchange.
|
|
8811
|
+
#
|
|
8812
|
+
# @option params [String] :client_secret
|
|
8813
|
+
# The client secret of the requested app client, if the client has a
|
|
8814
|
+
# secret.
|
|
8815
|
+
#
|
|
8816
|
+
# @option params [required, String] :subject_token
|
|
8817
|
+
# The token that you want to exchange for a new token. This is the
|
|
8818
|
+
# credential that represents the identity of the party on behalf of whom
|
|
8819
|
+
# the request is being made.
|
|
8820
|
+
#
|
|
8821
|
+
# @option params [required, String] :subject_token_type
|
|
8822
|
+
# The type of the `SubjectToken` that you want to exchange. Valid
|
|
8823
|
+
# values:
|
|
8824
|
+
#
|
|
8825
|
+
# * `ACCESS_TOKEN` – The subject token is an access token.
|
|
8826
|
+
#
|
|
8827
|
+
# * `ID_TOKEN` – The subject token is an ID token.
|
|
8828
|
+
#
|
|
8829
|
+
# * `SAML2` – The subject token is a SAML 2.0 assertion.
|
|
8830
|
+
#
|
|
8831
|
+
# @option params [String] :subject_token_provider_name
|
|
8832
|
+
# The name of the third-party identity provider that issued the
|
|
8833
|
+
# `SubjectToken`, if the subject token isn't a Amazon Cognito token.
|
|
8834
|
+
# Provide this value when your `SubjectToken` came from a SAML or OIDC
|
|
8835
|
+
# provider that you registered with your user pool, so that Amazon
|
|
8836
|
+
# Cognito can validate it against that provider's configuration. Omit
|
|
8837
|
+
# this parameter for a Amazon Cognito ID or access token.
|
|
8838
|
+
#
|
|
8839
|
+
# @option params [String] :actor_token
|
|
8840
|
+
# A token that identifies the intermediary service that is exchanging
|
|
8841
|
+
# the token on behalf of the user. When you provide an `ActorToken`, the
|
|
8842
|
+
# token that Amazon Cognito issues carries an `act` claim that
|
|
8843
|
+
# identifies the intermediary, so that downstream services can
|
|
8844
|
+
# distinguish a user acting directly from an intermediary acting on the
|
|
8845
|
+
# user's behalf.
|
|
8846
|
+
#
|
|
8847
|
+
# @option params [String] :actor_token_type
|
|
8848
|
+
# The type of the `ActorToken` that you provide. Required when you
|
|
8849
|
+
# provide an `ActorToken`. Valid values:
|
|
8850
|
+
#
|
|
8851
|
+
# * `ACCESS_TOKEN` – The actor token is an access token.
|
|
8852
|
+
#
|
|
8853
|
+
# * `ID_TOKEN` – The actor token is an ID token.
|
|
8854
|
+
#
|
|
8855
|
+
# * `SAML2` – The actor token is a SAML 2.0 assertion.
|
|
8856
|
+
#
|
|
8857
|
+
# @option params [String] :actor_token_provider_name
|
|
8858
|
+
# The name of the third-party identity provider that issued the
|
|
8859
|
+
# `ActorToken`, if the actor token isn't a Amazon Cognito token.
|
|
8860
|
+
#
|
|
8861
|
+
# @option params [Array<String>] :scopes
|
|
8862
|
+
# The scopes that you want the new token to have. Amazon Cognito issues
|
|
8863
|
+
# a token with the intersection of these requested scopes, the scopes of
|
|
8864
|
+
# your `SubjectToken`, and the scopes that are allowed for the
|
|
8865
|
+
# requesting app client. If you don't specify any scopes, Amazon
|
|
8866
|
+
# Cognito issues a token with the same scopes as your `SubjectToken`.
|
|
8867
|
+
#
|
|
8868
|
+
# @option params [Array<String>] :audiences
|
|
8869
|
+
# The logical name of the target service where you intend to use the
|
|
8870
|
+
# issued token. You can't request both `Audiences` and `Resources` in
|
|
8871
|
+
# the same request.
|
|
8872
|
+
#
|
|
8873
|
+
# @option params [Array<String>] :resources
|
|
8874
|
+
# The identifier of a resource server in your user pool where you intend
|
|
8875
|
+
# to use the issued token. You can't request both `Resources` and
|
|
8876
|
+
# `Audiences` in the same request.
|
|
8877
|
+
#
|
|
8878
|
+
# @option params [String] :requested_token_type
|
|
8879
|
+
# The type of token that you want Amazon Cognito to issue. Valid values:
|
|
8880
|
+
#
|
|
8881
|
+
# * `ACCESS_TOKEN` – Issues an access token.
|
|
8882
|
+
#
|
|
8883
|
+
# * `ID_TOKEN` – Issues an ID token.
|
|
8884
|
+
#
|
|
8885
|
+
# Amazon Cognito can't issue a SAML assertion, so `SAML2` isn't a
|
|
8886
|
+
# valid value for this parameter.
|
|
8887
|
+
#
|
|
8888
|
+
# @return [Types::GetDerivedTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8889
|
+
#
|
|
8890
|
+
# * {Types::GetDerivedTokenResponse#issued_token #issued_token} => String
|
|
8891
|
+
# * {Types::GetDerivedTokenResponse#issued_token_type #issued_token_type} => String
|
|
8892
|
+
# * {Types::GetDerivedTokenResponse#token_type #token_type} => String
|
|
8893
|
+
# * {Types::GetDerivedTokenResponse#expires_in #expires_in} => Integer
|
|
8894
|
+
# * {Types::GetDerivedTokenResponse#scopes #scopes} => Array<String>
|
|
8895
|
+
#
|
|
8896
|
+
#
|
|
8897
|
+
# @example Example: Example exchange a subject token for an audience-bound access token
|
|
8898
|
+
#
|
|
8899
|
+
# # The following example exchanges an access token for a new access token that is scoped and audience-bound for the
|
|
8900
|
+
# # solar-system-data resource server.
|
|
8901
|
+
#
|
|
8902
|
+
# resp = client.get_derived_token({
|
|
8903
|
+
# audiences: [
|
|
8904
|
+
# "solar-system-data",
|
|
8905
|
+
# ],
|
|
8906
|
+
# client_id: "1example23456789",
|
|
8907
|
+
# client_secret: "13ka4h7u28d9oo44tqpq9djqsfvhvu8rk4d2ighvpu0k8fj1c2r9",
|
|
8908
|
+
# scopes: [
|
|
8909
|
+
# "solar-system-data/asteroids.read",
|
|
8910
|
+
# ],
|
|
8911
|
+
# subject_token: "eyJra456defEXAMPLE",
|
|
8912
|
+
# subject_token_type: "ACCESS_TOKEN",
|
|
8913
|
+
# })
|
|
8914
|
+
#
|
|
8915
|
+
# resp.to_h outputs the following:
|
|
8916
|
+
# {
|
|
8917
|
+
# expires_in: 3600,
|
|
8918
|
+
# issued_token: "eyJra789ghiEXAMPLE",
|
|
8919
|
+
# issued_token_type: "ACCESS_TOKEN",
|
|
8920
|
+
# scopes: [
|
|
8921
|
+
# "solar-system-data/asteroids.read",
|
|
8922
|
+
# ],
|
|
8923
|
+
# token_type: "Bearer",
|
|
8924
|
+
# }
|
|
8925
|
+
#
|
|
8926
|
+
# @example Request syntax with placeholder values
|
|
8927
|
+
#
|
|
8928
|
+
# resp = client.get_derived_token({
|
|
8929
|
+
# client_id: "ClientIdType", # required
|
|
8930
|
+
# client_secret: "ClientSecretType",
|
|
8931
|
+
# subject_token: "GetDerivedTokenTokenModelType", # required
|
|
8932
|
+
# subject_token_type: "ACCESS_TOKEN", # required, accepts ACCESS_TOKEN, ID_TOKEN, SAML2
|
|
8933
|
+
# subject_token_provider_name: "ProviderNameType",
|
|
8934
|
+
# actor_token: "GetDerivedTokenTokenModelType",
|
|
8935
|
+
# actor_token_type: "ACCESS_TOKEN", # accepts ACCESS_TOKEN, ID_TOKEN, SAML2
|
|
8936
|
+
# actor_token_provider_name: "ProviderNameType",
|
|
8937
|
+
# scopes: ["ScopeType"],
|
|
8938
|
+
# audiences: ["AudienceType"],
|
|
8939
|
+
# resources: ["ResourceServerIdentifierType"],
|
|
8940
|
+
# requested_token_type: "ACCESS_TOKEN", # accepts ACCESS_TOKEN, ID_TOKEN
|
|
8941
|
+
# })
|
|
8942
|
+
#
|
|
8943
|
+
# @example Response structure
|
|
8944
|
+
#
|
|
8945
|
+
# resp.issued_token #=> String
|
|
8946
|
+
# resp.issued_token_type #=> String, one of "ACCESS_TOKEN", "ID_TOKEN"
|
|
8947
|
+
# resp.token_type #=> String, one of "Bearer", "N_A"
|
|
8948
|
+
# resp.expires_in #=> Integer
|
|
8949
|
+
# resp.scopes #=> Array
|
|
8950
|
+
# resp.scopes[0] #=> String
|
|
8951
|
+
#
|
|
8952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetDerivedToken AWS API Documentation
|
|
8953
|
+
#
|
|
8954
|
+
# @overload get_derived_token(params = {})
|
|
8955
|
+
# @param [Hash] params ({})
|
|
8956
|
+
def get_derived_token(params = {}, options = {})
|
|
8957
|
+
req = build_request(:get_derived_token, params)
|
|
8958
|
+
req.send_request(options)
|
|
8959
|
+
end
|
|
8960
|
+
|
|
8733
8961
|
# Given a device key, returns information about a remembered device for
|
|
8734
8962
|
# the current user. For more information about device authentication,
|
|
8735
8963
|
# see [Working with user devices in your user pool][1].
|
|
@@ -10398,6 +10626,7 @@ module Aws::CognitoIdentityProvider
|
|
|
10398
10626
|
# resp.resource_servers[0].scopes #=> Array
|
|
10399
10627
|
# resp.resource_servers[0].scopes[0].scope_name #=> String
|
|
10400
10628
|
# resp.resource_servers[0].scopes[0].scope_description #=> String
|
|
10629
|
+
# resp.resource_servers[0].managed_by #=> String, one of "COGNITO"
|
|
10401
10630
|
# resp.next_token #=> String
|
|
10402
10631
|
#
|
|
10403
10632
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListResourceServers AWS API Documentation
|
|
@@ -10680,6 +10909,26 @@ module Aws::CognitoIdentityProvider
|
|
|
10680
10909
|
# list. Subsequent requests return a new pagination token. By use of
|
|
10681
10910
|
# this token, you can paginate through the full list of items.
|
|
10682
10911
|
#
|
|
10912
|
+
# @option params [String] :client_type
|
|
10913
|
+
# Returns only app clients of this type. For dynamic client registration
|
|
10914
|
+
# (`DCR`) and other app clients, the following values are valid.
|
|
10915
|
+
#
|
|
10916
|
+
# REGULAR
|
|
10917
|
+
#
|
|
10918
|
+
# : An app client not created through dynamic client registration.
|
|
10919
|
+
#
|
|
10920
|
+
# DCR
|
|
10921
|
+
#
|
|
10922
|
+
# : An app client created through dynamic client registration.
|
|
10923
|
+
#
|
|
10924
|
+
# If you omit `ClientType`, the response includes app clients of all
|
|
10925
|
+
# types. When you set this filter, a page of results can contain fewer
|
|
10926
|
+
# app clients than `MaxResults`, or none, while the response still
|
|
10927
|
+
# includes a `NextToken`. Continue to request pages until the response
|
|
10928
|
+
# has no `NextToken`. The app clients in the response don't include
|
|
10929
|
+
# their type. To get the type of an app client, call
|
|
10930
|
+
# `DescribeUserPoolClient`.
|
|
10931
|
+
#
|
|
10683
10932
|
# @return [Types::ListUserPoolClientsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10684
10933
|
#
|
|
10685
10934
|
# * {Types::ListUserPoolClientsResponse#user_pool_clients #user_pool_clients} => Array<Types::UserPoolClientDescription>
|
|
@@ -10693,6 +10942,7 @@ module Aws::CognitoIdentityProvider
|
|
|
10693
10942
|
# user_pool_id: "UserPoolIdType", # required
|
|
10694
10943
|
# max_results: 1,
|
|
10695
10944
|
# next_token: "PaginationKey",
|
|
10945
|
+
# client_type: "REGULAR", # accepts REGULAR, DCR
|
|
10696
10946
|
# })
|
|
10697
10947
|
#
|
|
10698
10948
|
# @example Response structure
|
|
@@ -13998,6 +14248,7 @@ module Aws::CognitoIdentityProvider
|
|
|
13998
14248
|
# resp.resource_server.scopes #=> Array
|
|
13999
14249
|
# resp.resource_server.scopes[0].scope_name #=> String
|
|
14000
14250
|
# resp.resource_server.scopes[0].scope_description #=> String
|
|
14251
|
+
# resp.resource_server.managed_by #=> String, one of "COGNITO"
|
|
14001
14252
|
#
|
|
14002
14253
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateResourceServer AWS API Documentation
|
|
14003
14254
|
#
|
|
@@ -14449,6 +14700,26 @@ module Aws::CognitoIdentityProvider
|
|
|
14449
14700
|
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
|
|
14450
14701
|
# [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html
|
|
14451
14702
|
#
|
|
14703
|
+
# @option params [Types::DcrConfigurationType] :dcr_configuration
|
|
14704
|
+
# The dynamic client registration configuration for the user pool. With
|
|
14705
|
+
# dynamic client registration, applications can register their own app
|
|
14706
|
+
# clients at runtime through the registration endpoint of your user pool
|
|
14707
|
+
# domain. To activate this setting, your user pool must be in the [
|
|
14708
|
+
# Essentials tier][1] or higher.
|
|
14709
|
+
#
|
|
14710
|
+
# If you omit this parameter, Amazon Cognito keeps the existing
|
|
14711
|
+
# configuration. If you include it, Amazon Cognito replaces the existing
|
|
14712
|
+
# configuration with the one that you provide. Members that you omit
|
|
14713
|
+
# revert to their default values, and an omitted `EnableStatus` turns
|
|
14714
|
+
# dynamic client registration on.
|
|
14715
|
+
#
|
|
14716
|
+
# To change the feature plan of the user pool to Lite, you must also set
|
|
14717
|
+
# `EnableStatus` to `Disabled`.
|
|
14718
|
+
#
|
|
14719
|
+
#
|
|
14720
|
+
#
|
|
14721
|
+
# [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
|
|
14722
|
+
#
|
|
14452
14723
|
# @option params [Types::AccountRecoverySettingType] :account_recovery_setting
|
|
14453
14724
|
# The available verified method a user can use to recover their password
|
|
14454
14725
|
# when they call `ForgotPassword`. You can use this setting to define a
|
|
@@ -14608,6 +14879,13 @@ module Aws::CognitoIdentityProvider
|
|
|
14608
14879
|
# custom_auth_mode: "AUDIT", # accepts AUDIT, ENFORCED
|
|
14609
14880
|
# },
|
|
14610
14881
|
# },
|
|
14882
|
+
# dcr_configuration: {
|
|
14883
|
+
# enable_status: "Enabled", # accepts Enabled, Disabled
|
|
14884
|
+
# open_dcr_enabled: false,
|
|
14885
|
+
# authenticated_grant_types: ["code"], # accepts code, implicit, client_credentials
|
|
14886
|
+
# open_dcr_grant_types: ["code"], # accepts code, implicit, client_credentials
|
|
14887
|
+
# allowed_scopes: ["ScopeType"],
|
|
14888
|
+
# },
|
|
14611
14889
|
# account_recovery_setting: {
|
|
14612
14890
|
# recovery_mechanisms: [
|
|
14613
14891
|
# {
|
|
@@ -14821,6 +15099,15 @@ module Aws::CognitoIdentityProvider
|
|
|
14821
15099
|
#
|
|
14822
15100
|
# * `ALLOW_REFRESH_TOKEN_AUTH`: Enable authflow to refresh tokens.
|
|
14823
15101
|
#
|
|
15102
|
+
# * `ALLOW_TOKEN_EXCHANGE_IMPERSONATION` – Use this flow to request
|
|
15103
|
+
# `GetDerivedToken` token exchanges without an `ActorToken`. The
|
|
15104
|
+
# issued token represents the subject user directly.
|
|
15105
|
+
#
|
|
15106
|
+
# * `ALLOW_TOKEN_EXCHANGE_DELEGATION` – Use this flow to request
|
|
15107
|
+
# `GetDerivedToken` token exchanges that include an `ActorToken`. The
|
|
15108
|
+
# issued token carries an `act` claim that identifies the intermediary
|
|
15109
|
+
# acting on the behalf of the subject.
|
|
15110
|
+
#
|
|
14824
15111
|
# In some environments, you will see the values `ADMIN_NO_SRP_AUTH`,
|
|
14825
15112
|
# `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign
|
|
14826
15113
|
# these legacy `ExplicitAuthFlows` values to user pool clients at the
|
|
@@ -15038,7 +15325,7 @@ module Aws::CognitoIdentityProvider
|
|
|
15038
15325
|
# },
|
|
15039
15326
|
# read_attributes: ["ClientPermissionType"],
|
|
15040
15327
|
# write_attributes: ["ClientPermissionType"],
|
|
15041
|
-
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_AUTH
|
|
15328
|
+
# explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_AUTH, ALLOW_TOKEN_EXCHANGE_DELEGATION, ALLOW_TOKEN_EXCHANGE_IMPERSONATION
|
|
15042
15329
|
# supported_identity_providers: ["ProviderNameType"],
|
|
15043
15330
|
# callback_urls: ["RedirectUrlType"],
|
|
15044
15331
|
# logout_urls: ["RedirectUrlType"],
|
|
@@ -15082,7 +15369,7 @@ module Aws::CognitoIdentityProvider
|
|
|
15082
15369
|
# resp.user_pool_client.write_attributes #=> Array
|
|
15083
15370
|
# resp.user_pool_client.write_attributes[0] #=> String
|
|
15084
15371
|
# resp.user_pool_client.explicit_auth_flows #=> Array
|
|
15085
|
-
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH", "ALLOW_USER_AUTH"
|
|
15372
|
+
# resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH", "ALLOW_USER_AUTH", "ALLOW_TOKEN_EXCHANGE_DELEGATION", "ALLOW_TOKEN_EXCHANGE_IMPERSONATION"
|
|
15086
15373
|
# resp.user_pool_client.supported_identity_providers #=> Array
|
|
15087
15374
|
# resp.user_pool_client.supported_identity_providers[0] #=> String
|
|
15088
15375
|
# resp.user_pool_client.callback_urls #=> Array
|
|
@@ -15106,6 +15393,7 @@ module Aws::CognitoIdentityProvider
|
|
|
15106
15393
|
# resp.user_pool_client.auth_session_validity #=> Integer
|
|
15107
15394
|
# resp.user_pool_client.refresh_token_rotation.feature #=> String, one of "ENABLED", "DISABLED"
|
|
15108
15395
|
# resp.user_pool_client.refresh_token_rotation.retry_grace_period_seconds #=> Integer
|
|
15396
|
+
# resp.user_pool_client.client_type #=> String, one of "REGULAR", "DCR"
|
|
15109
15397
|
#
|
|
15110
15398
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClient AWS API Documentation
|
|
15111
15399
|
#
|
|
@@ -15454,7 +15742,7 @@ module Aws::CognitoIdentityProvider
|
|
|
15454
15742
|
tracer: tracer
|
|
15455
15743
|
)
|
|
15456
15744
|
context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
|
|
15457
|
-
context[:gem_version] = '1.
|
|
15745
|
+
context[:gem_version] = '1.166.0'
|
|
15458
15746
|
Seahorse::Client::Request.new(handlers, context)
|
|
15459
15747
|
end
|
|
15460
15748
|
|