@aws-sdk/client-cognito-identity-provider 3.974.0 → 3.978.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.
- package/dist-cjs/index.js +46 -23
- package/dist-es/CognitoIdentityProvider.js +21 -1
- package/dist-es/models/enums.js +3 -0
- package/dist-es/schemas/schemas_0.js +11 -4
- package/dist-types/CognitoIdentityProvider.d.ts +64 -1
- package/dist-types/commands/CreateUserPoolCommand.d.ts +16 -0
- package/dist-types/commands/DeleteUserPoolCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +4 -0
- package/dist-types/commands/ListUserPoolsCommand.d.ts +4 -0
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +1 -2
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +4 -0
- package/dist-types/models/enums.d.ts +11 -0
- package/dist-types/models/models_0.d.ts +24 -352
- package/dist-types/models/models_1.d.ts +353 -2
- package/dist-types/schemas/schemas_0.d.ts +1 -0
- package/dist-types/ts3.4/CognitoIdentityProvider.d.ts +68 -1
- package/dist-types/ts3.4/commands/UpdateUserPoolClientCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/enums.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +6 -25
- package/dist-types/ts3.4/models/models_1.d.ts +38 -2
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +1 -0
- package/package.json +17 -17
|
@@ -1,5 +1,356 @@
|
|
|
1
|
-
import { VerifySoftwareTokenResponseType } from "./enums";
|
|
2
|
-
import type { CustomDomainConfigType, UserPoolClientType } from "./models_0";
|
|
1
|
+
import { ExplicitAuthFlowsType, OAuthFlowType, PreventUserExistenceErrorTypes, VerifySoftwareTokenResponseType } from "./enums";
|
|
2
|
+
import type { AnalyticsConfigurationType, CustomDomainConfigType, RefreshTokenRotationType, TokenValidityUnitsType, UserPoolClientType } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* <p>Represents the request to update the user pool client.</p>
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface UpdateUserPoolClientRequest {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The ID of the user pool where you want to update the app client.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
UserPoolId: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>The ID of the app client that you want to update.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
ClientId: string | undefined;
|
|
18
|
+
/**
|
|
19
|
+
* <p>A friendly name for the app client.</p>
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
ClientName?: string | undefined;
|
|
23
|
+
/**
|
|
24
|
+
* <p>The refresh token time limit. After this limit expires, your user can't use
|
|
25
|
+
* their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
|
|
26
|
+
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
27
|
+
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
28
|
+
* <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and
|
|
29
|
+
* <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session
|
|
30
|
+
* and retrieve new access and ID tokens for 10 days.</p>
|
|
31
|
+
* <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days.
|
|
32
|
+
* You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the
|
|
33
|
+
* value with the default value of 30 days. <i>Valid range</i> is displayed below
|
|
34
|
+
* in seconds.</p>
|
|
35
|
+
* <p>If you don't specify otherwise in the configuration of your app client, your refresh
|
|
36
|
+
* tokens are valid for 30 days.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
RefreshTokenValidity?: number | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* <p>The access token time limit. After this limit expires, your user can't use
|
|
42
|
+
* their access token. To specify the time unit for <code>AccessTokenValidity</code> as
|
|
43
|
+
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
44
|
+
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
45
|
+
* <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and
|
|
46
|
+
* <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with
|
|
47
|
+
* their access token for 10 hours.</p>
|
|
48
|
+
* <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours.
|
|
49
|
+
* <i>Valid range</i> is displayed below in seconds.</p>
|
|
50
|
+
* <p>If you don't specify otherwise in the configuration of your app client, your access
|
|
51
|
+
* tokens are valid for one hour.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
AccessTokenValidity?: number | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* <p>The ID token time limit. After this limit expires, your user can't use
|
|
57
|
+
* their ID token. To specify the time unit for <code>IdTokenValidity</code> as
|
|
58
|
+
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
59
|
+
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
60
|
+
* <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and
|
|
61
|
+
* <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their
|
|
62
|
+
* session with their ID token for 10 hours.</p>
|
|
63
|
+
* <p>The default time unit for <code>IdTokenValidity</code> in an API request is hours.
|
|
64
|
+
* <i>Valid range</i> is displayed below in seconds.</p>
|
|
65
|
+
* <p>If you don't specify otherwise in the configuration of your app client, your ID
|
|
66
|
+
* tokens are valid for one hour.</p>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
IdTokenValidity?: number | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* <p>The units that validity times are represented in. The default unit for refresh tokens
|
|
72
|
+
* is days, and the default for ID and access tokens are hours.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
TokenValidityUnits?: TokenValidityUnitsType | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* <p>The list of user attributes that you want your app client to have read access to.
|
|
78
|
+
* After your user authenticates in your app, their access token authorizes them to read
|
|
79
|
+
* their own attribute value for any attribute in this list.</p>
|
|
80
|
+
* <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
|
|
81
|
+
* app can read the values of <code>email_verified</code>,
|
|
82
|
+
* <code>phone_number_verified</code>, and the standard attributes of your user pool.
|
|
83
|
+
* When your user pool app client has read access to these default attributes,
|
|
84
|
+
* <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
|
|
85
|
+
* populates <code>ReadAttributes</code> in the API response if you have specified your own
|
|
86
|
+
* custom set of read attributes.</p>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
ReadAttributes?: string[] | undefined;
|
|
90
|
+
/**
|
|
91
|
+
* <p>The list of user attributes that you want your app client to have write access to.
|
|
92
|
+
* After your user authenticates in your app, their access token authorizes them to set or
|
|
93
|
+
* modify their own attribute value for any attribute in this list.</p>
|
|
94
|
+
* <p>When you don't specify the <code>WriteAttributes</code> for your app client, your
|
|
95
|
+
* app can write the values of the Standard attributes of your user pool. When your user
|
|
96
|
+
* pool has write access to these default attributes, <code>WriteAttributes</code>
|
|
97
|
+
* doesn't return any information. Amazon Cognito only populates
|
|
98
|
+
* <code>WriteAttributes</code> in the API response if you have specified your own
|
|
99
|
+
* custom set of write attributes.</p>
|
|
100
|
+
* <p>If your app client allows users to sign in through an IdP, this array must include all
|
|
101
|
+
* attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when
|
|
102
|
+
* users sign in to your application through an IdP. If your app client does not have write
|
|
103
|
+
* access to a mapped attribute, Amazon Cognito throws an error when it tries to update the
|
|
104
|
+
* attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying IdP Attribute Mappings for Your user
|
|
105
|
+
* pool</a>.</p>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
WriteAttributes?: string[] | undefined;
|
|
109
|
+
/**
|
|
110
|
+
* <p>The <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html">authentication flows</a> that you want your user pool client to support. For each app
|
|
111
|
+
* client in your user pool, you can sign in your users with any combination of one or more flows, including with
|
|
112
|
+
* a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that
|
|
113
|
+
* you define with Lambda functions.</p>
|
|
114
|
+
* <note>
|
|
115
|
+
* <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your app client supports
|
|
116
|
+
* <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.
|
|
117
|
+
* </p>
|
|
118
|
+
* </note>
|
|
119
|
+
* <p>The values for authentication flow options include the following.</p>
|
|
120
|
+
* <ul>
|
|
121
|
+
* <li>
|
|
122
|
+
* <p>
|
|
123
|
+
* <code>ALLOW_USER_AUTH</code>: Enable selection-based sign-in
|
|
124
|
+
* with <code>USER_AUTH</code>. This setting covers username-password,
|
|
125
|
+
* secure remote password (SRP), passwordless, and passkey authentication.
|
|
126
|
+
* This authentiation flow can do username-password and SRP authentication
|
|
127
|
+
* without other <code>ExplicitAuthFlows</code> permitting them. For example
|
|
128
|
+
* users can complete an SRP challenge through <code>USER_AUTH</code>
|
|
129
|
+
* without the flow <code>USER_SRP_AUTH</code> being active for the app
|
|
130
|
+
* client. This flow doesn't include <code>CUSTOM_AUTH</code>.
|
|
131
|
+
* </p>
|
|
132
|
+
* <p>To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
|
|
133
|
+
* Essentials tier</a> or higher.</p>
|
|
134
|
+
* </li>
|
|
135
|
+
* <li>
|
|
136
|
+
* <p>
|
|
137
|
+
* <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password
|
|
138
|
+
* authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces
|
|
139
|
+
* the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, your app
|
|
140
|
+
* passes a user name and password to Amazon Cognito in the request, instead of using the Secure
|
|
141
|
+
* Remote Password (SRP) protocol to securely transmit the password.</p>
|
|
142
|
+
* </li>
|
|
143
|
+
* <li>
|
|
144
|
+
* <p>
|
|
145
|
+
* <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based
|
|
146
|
+
* authentication.</p>
|
|
147
|
+
* </li>
|
|
148
|
+
* <li>
|
|
149
|
+
* <p>
|
|
150
|
+
* <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based
|
|
151
|
+
* authentication. In this flow, Amazon Cognito receives the password in the request instead
|
|
152
|
+
* of using the SRP protocol to verify passwords.</p>
|
|
153
|
+
* </li>
|
|
154
|
+
* <li>
|
|
155
|
+
* <p>
|
|
156
|
+
* <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p>
|
|
157
|
+
* </li>
|
|
158
|
+
* <li>
|
|
159
|
+
* <p>
|
|
160
|
+
* <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh
|
|
161
|
+
* tokens.</p>
|
|
162
|
+
* </li>
|
|
163
|
+
* </ul>
|
|
164
|
+
* <p>In some environments, you will see the values <code>ADMIN_NO_SRP_AUTH</code>, <code>CUSTOM_AUTH_FLOW_ONLY</code>, or <code>USER_PASSWORD_AUTH</code>.
|
|
165
|
+
* You can't assign these legacy <code>ExplicitAuthFlows</code> values to user pool clients at the same time as values that begin with <code>ALLOW_</code>,
|
|
166
|
+
* like <code>ALLOW_USER_SRP_AUTH</code>.</p>
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
ExplicitAuthFlows?: ExplicitAuthFlowsType[] | undefined;
|
|
170
|
+
/**
|
|
171
|
+
* <p>A list of provider names for the identity providers (IdPs) that are supported on this
|
|
172
|
+
* client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>,
|
|
173
|
+
* <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
|
|
174
|
+
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
|
|
175
|
+
* user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
|
|
176
|
+
* <p>This parameter sets the IdPs that <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">managed
|
|
177
|
+
* login</a> will display on the login page for your app client. The removal of
|
|
178
|
+
* <code>COGNITO</code> from this list doesn't prevent authentication operations
|
|
179
|
+
* for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent
|
|
180
|
+
* SDK-based authentication is to block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a>.
|
|
181
|
+
* </p>
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
SupportedIdentityProviders?: string[] | undefined;
|
|
185
|
+
/**
|
|
186
|
+
* <p>A list of allowed redirect, or callback, URLs for managed login authentication. These
|
|
187
|
+
* URLs are the paths where you want to send your users' browsers after they complete
|
|
188
|
+
* authentication with managed login or a third-party IdP. Typically, callback URLs are the
|
|
189
|
+
* home of an application that uses OAuth or OIDC libraries to process authentication
|
|
190
|
+
* outcomes.</p>
|
|
191
|
+
* <p>A redirect URI must meet the following requirements:</p>
|
|
192
|
+
* <ul>
|
|
193
|
+
* <li>
|
|
194
|
+
* <p>Be an absolute URI.</p>
|
|
195
|
+
* </li>
|
|
196
|
+
* <li>
|
|
197
|
+
* <p>Be registered with the authorization server. Amazon Cognito doesn't accept
|
|
198
|
+
* authorization requests with <code>redirect_uri</code> values that aren't in
|
|
199
|
+
* the list of <code>CallbackURLs</code> that you provide in this parameter.</p>
|
|
200
|
+
* </li>
|
|
201
|
+
* <li>
|
|
202
|
+
* <p>Not include a fragment component.</p>
|
|
203
|
+
* </li>
|
|
204
|
+
* </ul>
|
|
205
|
+
* <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 -
|
|
206
|
+
* Redirection Endpoint</a>.</p>
|
|
207
|
+
* <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes
|
|
208
|
+
* only.</p>
|
|
209
|
+
* <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
CallbackURLs?: string[] | undefined;
|
|
213
|
+
/**
|
|
214
|
+
* <p>A list of allowed logout URLs for managed login authentication. When you pass
|
|
215
|
+
* <code>logout_uri</code> and <code>client_id</code> parameters to
|
|
216
|
+
* <code>/logout</code>, Amazon Cognito signs out your user and redirects them to the logout
|
|
217
|
+
* URL. This parameter describes the URLs that you want to be the permitted targets of
|
|
218
|
+
* <code>logout_uri</code>. A typical use of these URLs is when a user selects "Sign
|
|
219
|
+
* out" and you redirect them to your public homepage. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html">Logout
|
|
220
|
+
* endpoint</a>.</p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
LogoutURLs?: string[] | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* <p>The default redirect URI. In app clients with one assigned IdP, replaces
|
|
226
|
+
* <code>redirect_uri</code> in authentication requests. Must be in the
|
|
227
|
+
* <code>CallbackURLs</code> list.</p>
|
|
228
|
+
* @public
|
|
229
|
+
*/
|
|
230
|
+
DefaultRedirectURI?: string | undefined;
|
|
231
|
+
/**
|
|
232
|
+
* <p>The OAuth grant types that you want your app client to generate. To create an app
|
|
233
|
+
* client that generates client credentials grants, you must add
|
|
234
|
+
* <code>client_credentials</code> as the only allowed OAuth flow.</p>
|
|
235
|
+
* <dl>
|
|
236
|
+
* <dt>code</dt>
|
|
237
|
+
* <dd>
|
|
238
|
+
* <p>Use a code grant flow, which provides an authorization code as the
|
|
239
|
+
* response. This code can be exchanged for access tokens with the
|
|
240
|
+
* <code>/oauth2/token</code> endpoint.</p>
|
|
241
|
+
* </dd>
|
|
242
|
+
* <dt>implicit</dt>
|
|
243
|
+
* <dd>
|
|
244
|
+
* <p>Issue the access token (and, optionally, ID token, based on scopes)
|
|
245
|
+
* directly to your user.</p>
|
|
246
|
+
* </dd>
|
|
247
|
+
* <dt>client_credentials</dt>
|
|
248
|
+
* <dd>
|
|
249
|
+
* <p>Issue the access token from the <code>/oauth2/token</code> endpoint
|
|
250
|
+
* directly to a non-person user using a combination of the client ID and
|
|
251
|
+
* client secret.</p>
|
|
252
|
+
* </dd>
|
|
253
|
+
* </dl>
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
AllowedOAuthFlows?: OAuthFlowType[] | undefined;
|
|
257
|
+
/**
|
|
258
|
+
* <p>The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app
|
|
259
|
+
* client to authorize access with. Scopes govern access control to user pool self-service
|
|
260
|
+
* API operations, user data from the <code>userInfo</code> endpoint, and third-party APIs.
|
|
261
|
+
* Scope values include <code>phone</code>, <code>email</code>, <code>openid</code>, and
|
|
262
|
+
* <code>profile</code>. The <code>aws.cognito.signin.user.admin</code> scope
|
|
263
|
+
* authorizes user self-service operations. Custom scopes with resource servers authorize
|
|
264
|
+
* access to external APIs.</p>
|
|
265
|
+
* @public
|
|
266
|
+
*/
|
|
267
|
+
AllowedOAuthScopes?: string[] | undefined;
|
|
268
|
+
/**
|
|
269
|
+
* <p>Set to <code>true</code> to use OAuth 2.0 authorization server features in your app client.</p>
|
|
270
|
+
* <p>This parameter must have a value of <code>true</code> before you can configure
|
|
271
|
+
* the following features in your app client.</p>
|
|
272
|
+
* <ul>
|
|
273
|
+
* <li>
|
|
274
|
+
* <p>
|
|
275
|
+
* <code>CallBackURLs</code>: Callback URLs.</p>
|
|
276
|
+
* </li>
|
|
277
|
+
* <li>
|
|
278
|
+
* <p>
|
|
279
|
+
* <code>LogoutURLs</code>: Sign-out redirect URLs.</p>
|
|
280
|
+
* </li>
|
|
281
|
+
* <li>
|
|
282
|
+
* <p>
|
|
283
|
+
* <code>AllowedOAuthScopes</code>: OAuth 2.0 scopes.</p>
|
|
284
|
+
* </li>
|
|
285
|
+
* <li>
|
|
286
|
+
* <p>
|
|
287
|
+
* <code>AllowedOAuthFlows</code>: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.</p>
|
|
288
|
+
* </li>
|
|
289
|
+
* </ul>
|
|
290
|
+
* <p>To use authorization server features, configure one of these features in the Amazon Cognito console or set
|
|
291
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> to <code>true</code> in a <code>CreateUserPoolClient</code> or
|
|
292
|
+
* <code>UpdateUserPoolClient</code> API request. If you don't set a value for
|
|
293
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
|
|
294
|
+
* to <code>false</code>. When <code>false</code>, only SDK-based API sign-in is permitted.</p>
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
|
|
298
|
+
/**
|
|
299
|
+
* <p>The user pool analytics configuration for collecting metrics and sending them to your
|
|
300
|
+
* Amazon Pinpoint campaign.</p>
|
|
301
|
+
* <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools might not have access to
|
|
302
|
+
* analytics or might be configurable with campaigns in the US East (N. Virginia) Region.
|
|
303
|
+
* For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html">Using Amazon Pinpoint analytics</a>.</p>
|
|
304
|
+
* @public
|
|
305
|
+
*/
|
|
306
|
+
AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
|
|
307
|
+
/**
|
|
308
|
+
* <p>When <code>ENABLED</code>, suppresses messages that might indicate a valid user exists
|
|
309
|
+
* when someone attempts sign-in. This parameters sets your preference for the errors and
|
|
310
|
+
* responses that you want Amazon Cognito APIs to return during authentication, account
|
|
311
|
+
* confirmation, and password recovery when the user doesn't exist in the user pool. When
|
|
312
|
+
* set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error
|
|
313
|
+
* indicating either the username or password was incorrect. Account confirmation and
|
|
314
|
+
* password recovery return a response indicating a code was sent to a simulated
|
|
315
|
+
* destination. When set to <code>LEGACY</code>, those APIs return a
|
|
316
|
+
* <code>UserNotFoundException</code> exception if the user doesn't exist in the user
|
|
317
|
+
* pool.</p>
|
|
318
|
+
* <p>Defaults to <code>LEGACY</code>.</p>
|
|
319
|
+
* @public
|
|
320
|
+
*/
|
|
321
|
+
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
|
|
322
|
+
/**
|
|
323
|
+
* <p>Activates or deactivates <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html">token
|
|
324
|
+
* revocation</a> in the target app client.</p>
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
327
|
+
EnableTokenRevocation?: boolean | undefined;
|
|
328
|
+
/**
|
|
329
|
+
* <p>When <code>true</code>, your application can include additional
|
|
330
|
+
* <code>UserContextData</code> in authentication requests. This data includes the IP
|
|
331
|
+
* address, and contributes to analysis by threat protection features. For more information
|
|
332
|
+
* about propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint">Adding session data to API requests</a>. If you don’t include this parameter,
|
|
333
|
+
* you can't send the source IP address to Amazon Cognito threat protection features. You can only
|
|
334
|
+
* activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has
|
|
335
|
+
* a client secret.</p>
|
|
336
|
+
* @public
|
|
337
|
+
*/
|
|
338
|
+
EnablePropagateAdditionalUserContextData?: boolean | undefined;
|
|
339
|
+
/**
|
|
340
|
+
* <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration,
|
|
341
|
+
* in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
AuthSessionValidity?: number | undefined;
|
|
345
|
+
/**
|
|
346
|
+
* <p>The configuration of your app client for refresh token rotation. When enabled, your
|
|
347
|
+
* app client issues new ID, access, and refresh tokens when users renew their sessions
|
|
348
|
+
* with refresh tokens. When disabled, token refresh issues only ID and access
|
|
349
|
+
* tokens.</p>
|
|
350
|
+
* @public
|
|
351
|
+
*/
|
|
352
|
+
RefreshTokenRotation?: RefreshTokenRotationType | undefined;
|
|
353
|
+
}
|
|
3
354
|
/**
|
|
4
355
|
* <p>Represents the response from the server to the request to update the user pool
|
|
5
356
|
* client.</p>
|
|
@@ -188,6 +188,7 @@ export declare var GroupExistsException$: StaticErrorSchema;
|
|
|
188
188
|
export declare var GroupType$: StaticStructureSchema;
|
|
189
189
|
export declare var HttpHeader$: StaticStructureSchema;
|
|
190
190
|
export declare var IdentityProviderType$: StaticStructureSchema;
|
|
191
|
+
export declare var InboundFederationLambdaType$: StaticStructureSchema;
|
|
191
192
|
export declare var InitiateAuthRequest$: StaticStructureSchema;
|
|
192
193
|
export declare var InitiateAuthResponse$: StaticStructureSchema;
|
|
193
194
|
export declare var InternalErrorException$: StaticErrorSchema;
|
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import {
|
|
2
|
+
HttpHandlerOptions as __HttpHandlerOptions,
|
|
3
|
+
PaginationConfiguration,
|
|
4
|
+
Paginator,
|
|
5
|
+
} from "@smithy/types";
|
|
2
6
|
import { CognitoIdentityProviderClient } from "./CognitoIdentityProviderClient";
|
|
3
7
|
import {
|
|
4
8
|
AddCustomAttributesCommandInput,
|
|
@@ -2032,6 +2036,69 @@ export interface CognitoIdentityProvider {
|
|
|
2032
2036
|
options: __HttpHandlerOptions,
|
|
2033
2037
|
cb: (err: any, data?: VerifyUserAttributeCommandOutput) => void
|
|
2034
2038
|
): void;
|
|
2039
|
+
paginateAdminListGroupsForUser(
|
|
2040
|
+
args: AdminListGroupsForUserCommandInput,
|
|
2041
|
+
paginationConfig?: Pick<
|
|
2042
|
+
PaginationConfiguration,
|
|
2043
|
+
Exclude<keyof PaginationConfiguration, "client">
|
|
2044
|
+
>
|
|
2045
|
+
): Paginator<AdminListGroupsForUserCommandOutput>;
|
|
2046
|
+
paginateAdminListUserAuthEvents(
|
|
2047
|
+
args: AdminListUserAuthEventsCommandInput,
|
|
2048
|
+
paginationConfig?: Pick<
|
|
2049
|
+
PaginationConfiguration,
|
|
2050
|
+
Exclude<keyof PaginationConfiguration, "client">
|
|
2051
|
+
>
|
|
2052
|
+
): Paginator<AdminListUserAuthEventsCommandOutput>;
|
|
2053
|
+
paginateListGroups(
|
|
2054
|
+
args: ListGroupsCommandInput,
|
|
2055
|
+
paginationConfig?: Pick<
|
|
2056
|
+
PaginationConfiguration,
|
|
2057
|
+
Exclude<keyof PaginationConfiguration, "client">
|
|
2058
|
+
>
|
|
2059
|
+
): Paginator<ListGroupsCommandOutput>;
|
|
2060
|
+
paginateListIdentityProviders(
|
|
2061
|
+
args: ListIdentityProvidersCommandInput,
|
|
2062
|
+
paginationConfig?: Pick<
|
|
2063
|
+
PaginationConfiguration,
|
|
2064
|
+
Exclude<keyof PaginationConfiguration, "client">
|
|
2065
|
+
>
|
|
2066
|
+
): Paginator<ListIdentityProvidersCommandOutput>;
|
|
2067
|
+
paginateListResourceServers(
|
|
2068
|
+
args: ListResourceServersCommandInput,
|
|
2069
|
+
paginationConfig?: Pick<
|
|
2070
|
+
PaginationConfiguration,
|
|
2071
|
+
Exclude<keyof PaginationConfiguration, "client">
|
|
2072
|
+
>
|
|
2073
|
+
): Paginator<ListResourceServersCommandOutput>;
|
|
2074
|
+
paginateListUserPoolClients(
|
|
2075
|
+
args: ListUserPoolClientsCommandInput,
|
|
2076
|
+
paginationConfig?: Pick<
|
|
2077
|
+
PaginationConfiguration,
|
|
2078
|
+
Exclude<keyof PaginationConfiguration, "client">
|
|
2079
|
+
>
|
|
2080
|
+
): Paginator<ListUserPoolClientsCommandOutput>;
|
|
2081
|
+
paginateListUserPools(
|
|
2082
|
+
args: ListUserPoolsCommandInput,
|
|
2083
|
+
paginationConfig?: Pick<
|
|
2084
|
+
PaginationConfiguration,
|
|
2085
|
+
Exclude<keyof PaginationConfiguration, "client">
|
|
2086
|
+
>
|
|
2087
|
+
): Paginator<ListUserPoolsCommandOutput>;
|
|
2088
|
+
paginateListUsers(
|
|
2089
|
+
args: ListUsersCommandInput,
|
|
2090
|
+
paginationConfig?: Pick<
|
|
2091
|
+
PaginationConfiguration,
|
|
2092
|
+
Exclude<keyof PaginationConfiguration, "client">
|
|
2093
|
+
>
|
|
2094
|
+
): Paginator<ListUsersCommandOutput>;
|
|
2095
|
+
paginateListUsersInGroup(
|
|
2096
|
+
args: ListUsersInGroupCommandInput,
|
|
2097
|
+
paginationConfig?: Pick<
|
|
2098
|
+
PaginationConfiguration,
|
|
2099
|
+
Exclude<keyof PaginationConfiguration, "client">
|
|
2100
|
+
>
|
|
2101
|
+
): Paginator<ListUsersInGroupCommandOutput>;
|
|
2035
2102
|
}
|
|
2036
2103
|
export declare class CognitoIdentityProvider
|
|
2037
2104
|
extends CognitoIdentityProviderClient
|
|
@@ -5,8 +5,10 @@ import {
|
|
|
5
5
|
ServiceInputTypes,
|
|
6
6
|
ServiceOutputTypes,
|
|
7
7
|
} from "../CognitoIdentityProviderClient";
|
|
8
|
-
import {
|
|
9
|
-
|
|
8
|
+
import {
|
|
9
|
+
UpdateUserPoolClientRequest,
|
|
10
|
+
UpdateUserPoolClientResponse,
|
|
11
|
+
} from "../models/models_1";
|
|
10
12
|
export { __MetadataBearer };
|
|
11
13
|
export { $Command };
|
|
12
14
|
export interface UpdateUserPoolClientCommandInput
|
|
@@ -250,6 +250,11 @@ export declare const CustomSMSSenderLambdaVersionType: {
|
|
|
250
250
|
};
|
|
251
251
|
export type CustomSMSSenderLambdaVersionType =
|
|
252
252
|
(typeof CustomSMSSenderLambdaVersionType)[keyof typeof CustomSMSSenderLambdaVersionType];
|
|
253
|
+
export declare const InboundFederationLambdaVersionType: {
|
|
254
|
+
readonly V1_0: "V1_0";
|
|
255
|
+
};
|
|
256
|
+
export type InboundFederationLambdaVersionType =
|
|
257
|
+
(typeof InboundFederationLambdaVersionType)[keyof typeof InboundFederationLambdaVersionType];
|
|
253
258
|
export declare const PreTokenGenerationLambdaVersionType: {
|
|
254
259
|
readonly V1_0: "V1_0";
|
|
255
260
|
readonly V2_0: "V2_0";
|
|
@@ -30,6 +30,7 @@ import {
|
|
|
30
30
|
FeatureType,
|
|
31
31
|
FeedbackValueType,
|
|
32
32
|
IdentityProviderTypeType,
|
|
33
|
+
InboundFederationLambdaVersionType,
|
|
33
34
|
LogLevel,
|
|
34
35
|
MessageActionType,
|
|
35
36
|
OAuthFlowType,
|
|
@@ -638,6 +639,10 @@ export interface CustomSMSLambdaVersionConfigType {
|
|
|
638
639
|
LambdaVersion: CustomSMSSenderLambdaVersionType | undefined;
|
|
639
640
|
LambdaArn: string | undefined;
|
|
640
641
|
}
|
|
642
|
+
export interface InboundFederationLambdaType {
|
|
643
|
+
LambdaVersion: InboundFederationLambdaVersionType | undefined;
|
|
644
|
+
LambdaArn: string | undefined;
|
|
645
|
+
}
|
|
641
646
|
export interface PreTokenGenerationVersionConfigType {
|
|
642
647
|
LambdaVersion: PreTokenGenerationLambdaVersionType | undefined;
|
|
643
648
|
LambdaArn: string | undefined;
|
|
@@ -657,6 +662,7 @@ export interface LambdaConfigType {
|
|
|
657
662
|
CustomSMSSender?: CustomSMSLambdaVersionConfigType | undefined;
|
|
658
663
|
CustomEmailSender?: CustomEmailLambdaVersionConfigType | undefined;
|
|
659
664
|
KMSKeyID?: string | undefined;
|
|
665
|
+
InboundFederation?: InboundFederationLambdaType | undefined;
|
|
660
666
|
}
|
|
661
667
|
export interface PasswordPolicyType {
|
|
662
668
|
MinimumLength?: number | undefined;
|
|
@@ -1544,28 +1550,3 @@ export interface UpdateUserPoolRequest {
|
|
|
1544
1550
|
UserPoolTier?: UserPoolTierType | undefined;
|
|
1545
1551
|
}
|
|
1546
1552
|
export interface UpdateUserPoolResponse {}
|
|
1547
|
-
export interface UpdateUserPoolClientRequest {
|
|
1548
|
-
UserPoolId: string | undefined;
|
|
1549
|
-
ClientId: string | undefined;
|
|
1550
|
-
ClientName?: string | undefined;
|
|
1551
|
-
RefreshTokenValidity?: number | undefined;
|
|
1552
|
-
AccessTokenValidity?: number | undefined;
|
|
1553
|
-
IdTokenValidity?: number | undefined;
|
|
1554
|
-
TokenValidityUnits?: TokenValidityUnitsType | undefined;
|
|
1555
|
-
ReadAttributes?: string[] | undefined;
|
|
1556
|
-
WriteAttributes?: string[] | undefined;
|
|
1557
|
-
ExplicitAuthFlows?: ExplicitAuthFlowsType[] | undefined;
|
|
1558
|
-
SupportedIdentityProviders?: string[] | undefined;
|
|
1559
|
-
CallbackURLs?: string[] | undefined;
|
|
1560
|
-
LogoutURLs?: string[] | undefined;
|
|
1561
|
-
DefaultRedirectURI?: string | undefined;
|
|
1562
|
-
AllowedOAuthFlows?: OAuthFlowType[] | undefined;
|
|
1563
|
-
AllowedOAuthScopes?: string[] | undefined;
|
|
1564
|
-
AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
|
|
1565
|
-
AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
|
|
1566
|
-
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
|
|
1567
|
-
EnableTokenRevocation?: boolean | undefined;
|
|
1568
|
-
EnablePropagateAdditionalUserContextData?: boolean | undefined;
|
|
1569
|
-
AuthSessionValidity?: number | undefined;
|
|
1570
|
-
RefreshTokenRotation?: RefreshTokenRotationType | undefined;
|
|
1571
|
-
}
|
|
@@ -1,5 +1,41 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
1
|
+
import {
|
|
2
|
+
ExplicitAuthFlowsType,
|
|
3
|
+
OAuthFlowType,
|
|
4
|
+
PreventUserExistenceErrorTypes,
|
|
5
|
+
VerifySoftwareTokenResponseType,
|
|
6
|
+
} from "./enums";
|
|
7
|
+
import {
|
|
8
|
+
AnalyticsConfigurationType,
|
|
9
|
+
CustomDomainConfigType,
|
|
10
|
+
RefreshTokenRotationType,
|
|
11
|
+
TokenValidityUnitsType,
|
|
12
|
+
UserPoolClientType,
|
|
13
|
+
} from "./models_0";
|
|
14
|
+
export interface UpdateUserPoolClientRequest {
|
|
15
|
+
UserPoolId: string | undefined;
|
|
16
|
+
ClientId: string | undefined;
|
|
17
|
+
ClientName?: string | undefined;
|
|
18
|
+
RefreshTokenValidity?: number | undefined;
|
|
19
|
+
AccessTokenValidity?: number | undefined;
|
|
20
|
+
IdTokenValidity?: number | undefined;
|
|
21
|
+
TokenValidityUnits?: TokenValidityUnitsType | undefined;
|
|
22
|
+
ReadAttributes?: string[] | undefined;
|
|
23
|
+
WriteAttributes?: string[] | undefined;
|
|
24
|
+
ExplicitAuthFlows?: ExplicitAuthFlowsType[] | undefined;
|
|
25
|
+
SupportedIdentityProviders?: string[] | undefined;
|
|
26
|
+
CallbackURLs?: string[] | undefined;
|
|
27
|
+
LogoutURLs?: string[] | undefined;
|
|
28
|
+
DefaultRedirectURI?: string | undefined;
|
|
29
|
+
AllowedOAuthFlows?: OAuthFlowType[] | undefined;
|
|
30
|
+
AllowedOAuthScopes?: string[] | undefined;
|
|
31
|
+
AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
|
|
32
|
+
AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
|
|
33
|
+
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
|
|
34
|
+
EnableTokenRevocation?: boolean | undefined;
|
|
35
|
+
EnablePropagateAdditionalUserContextData?: boolean | undefined;
|
|
36
|
+
AuthSessionValidity?: number | undefined;
|
|
37
|
+
RefreshTokenRotation?: RefreshTokenRotationType | undefined;
|
|
38
|
+
}
|
|
3
39
|
export interface UpdateUserPoolClientResponse {
|
|
4
40
|
UserPoolClient?: UserPoolClientType | undefined;
|
|
5
41
|
}
|
|
@@ -192,6 +192,7 @@ export declare var GroupExistsException$: StaticErrorSchema;
|
|
|
192
192
|
export declare var GroupType$: StaticStructureSchema;
|
|
193
193
|
export declare var HttpHeader$: StaticStructureSchema;
|
|
194
194
|
export declare var IdentityProviderType$: StaticStructureSchema;
|
|
195
|
+
export declare var InboundFederationLambdaType$: StaticStructureSchema;
|
|
195
196
|
export declare var InitiateAuthRequest$: StaticStructureSchema;
|
|
196
197
|
export declare var InitiateAuthResponse$: StaticStructureSchema;
|
|
197
198
|
export declare var InternalErrorException$: StaticErrorSchema;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-cognito-identity-provider",
|
|
3
3
|
"description": "AWS SDK for JavaScript Cognito Identity Provider Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.978.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-cognito-identity-provider",
|
|
@@ -21,38 +21,38 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
24
|
-
"@aws-sdk/core": "^3.973.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "^3.972.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "^3.972.
|
|
27
|
-
"@aws-sdk/middleware-logger": "^3.972.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "^3.972.
|
|
29
|
-
"@aws-sdk/middleware-user-agent": "^3.972.
|
|
30
|
-
"@aws-sdk/region-config-resolver": "^3.972.
|
|
31
|
-
"@aws-sdk/types": "^3.973.
|
|
24
|
+
"@aws-sdk/core": "^3.973.4",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "^3.972.2",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "^3.972.2",
|
|
27
|
+
"@aws-sdk/middleware-logger": "^3.972.2",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "^3.972.2",
|
|
29
|
+
"@aws-sdk/middleware-user-agent": "^3.972.4",
|
|
30
|
+
"@aws-sdk/region-config-resolver": "^3.972.2",
|
|
31
|
+
"@aws-sdk/types": "^3.973.1",
|
|
32
32
|
"@aws-sdk/util-endpoints": "3.972.0",
|
|
33
|
-
"@aws-sdk/util-user-agent-browser": "^3.972.
|
|
34
|
-
"@aws-sdk/util-user-agent-node": "^3.972.
|
|
33
|
+
"@aws-sdk/util-user-agent-browser": "^3.972.2",
|
|
34
|
+
"@aws-sdk/util-user-agent-node": "^3.972.2",
|
|
35
35
|
"@smithy/config-resolver": "^4.4.6",
|
|
36
|
-
"@smithy/core": "^3.
|
|
36
|
+
"@smithy/core": "^3.22.0",
|
|
37
37
|
"@smithy/fetch-http-handler": "^5.3.9",
|
|
38
38
|
"@smithy/hash-node": "^4.2.8",
|
|
39
39
|
"@smithy/invalid-dependency": "^4.2.8",
|
|
40
40
|
"@smithy/middleware-content-length": "^4.2.8",
|
|
41
|
-
"@smithy/middleware-endpoint": "^4.4.
|
|
42
|
-
"@smithy/middleware-retry": "^4.4.
|
|
41
|
+
"@smithy/middleware-endpoint": "^4.4.12",
|
|
42
|
+
"@smithy/middleware-retry": "^4.4.29",
|
|
43
43
|
"@smithy/middleware-serde": "^4.2.9",
|
|
44
44
|
"@smithy/middleware-stack": "^4.2.8",
|
|
45
45
|
"@smithy/node-config-provider": "^4.3.8",
|
|
46
46
|
"@smithy/node-http-handler": "^4.4.8",
|
|
47
47
|
"@smithy/protocol-http": "^5.3.8",
|
|
48
|
-
"@smithy/smithy-client": "^4.
|
|
48
|
+
"@smithy/smithy-client": "^4.11.1",
|
|
49
49
|
"@smithy/types": "^4.12.0",
|
|
50
50
|
"@smithy/url-parser": "^4.2.8",
|
|
51
51
|
"@smithy/util-base64": "^4.3.0",
|
|
52
52
|
"@smithy/util-body-length-browser": "^4.2.0",
|
|
53
53
|
"@smithy/util-body-length-node": "^4.2.1",
|
|
54
|
-
"@smithy/util-defaults-mode-browser": "^4.3.
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^4.2.
|
|
54
|
+
"@smithy/util-defaults-mode-browser": "^4.3.28",
|
|
55
|
+
"@smithy/util-defaults-mode-node": "^4.2.31",
|
|
56
56
|
"@smithy/util-endpoints": "^3.2.8",
|
|
57
57
|
"@smithy/util-middleware": "^4.2.8",
|
|
58
58
|
"@smithy/util-retry": "^4.2.8",
|