@aws-sdk/client-cognito-identity-provider 3.933.0 → 3.935.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 +282 -282
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +281 -0
- package/dist-es/models/errors.js +663 -0
- package/dist-es/models/models_0.js +1 -876
- package/dist-es/models/models_1.js +1 -69
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/GetTokensFromRefreshTokenCommand.d.ts +1 -2
- package/dist-types/commands/GetUICustomizationCommand.d.ts +1 -1
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +1 -1
- package/dist-types/commands/GetUserAuthFactorsCommand.d.ts +1 -1
- package/dist-types/commands/GetUserCommand.d.ts +1 -1
- package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +1 -1
- package/dist-types/commands/GlobalSignOutCommand.d.ts +1 -1
- package/dist-types/commands/InitiateAuthCommand.d.ts +1 -1
- package/dist-types/commands/ListDevicesCommand.d.ts +1 -1
- package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListIdentityProvidersCommand.d.ts +1 -1
- package/dist-types/commands/ListResourceServersCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTermsCommand.d.ts +1 -1
- package/dist-types/commands/ListUserImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListUserPoolClientsCommand.d.ts +1 -1
- package/dist-types/commands/ListUserPoolsCommand.d.ts +1 -1
- package/dist-types/commands/ListUsersCommand.d.ts +1 -1
- package/dist-types/commands/ListUsersInGroupCommand.d.ts +1 -1
- package/dist-types/commands/ListWebAuthnCredentialsCommand.d.ts +1 -1
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +1 -1
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +1 -1
- package/dist-types/commands/RevokeTokenCommand.d.ts +1 -1
- package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/SetUICustomizationCommand.d.ts +1 -1
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +1 -1
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +1 -1
- package/dist-types/commands/SetUserSettingsCommand.d.ts +1 -1
- package/dist-types/commands/SignUpCommand.d.ts +1 -1
- package/dist-types/commands/StartUserImportJobCommand.d.ts +1 -1
- package/dist-types/commands/StartWebAuthnRegistrationCommand.d.ts +1 -1
- package/dist-types/commands/StopUserImportJobCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +1 -1
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTermsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +1 -1
- package/dist-types/index.d.ts +4 -1
- package/dist-types/models/enums.d.ts +681 -0
- package/dist-types/models/errors.d.ts +710 -0
- package/dist-types/models/models_0.d.ts +3866 -1311
- package/dist-types/models/models_1.d.ts +2 -3949
- package/dist-types/ts3.4/commands/GetTokensFromRefreshTokenCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/GetUICustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetUserAttributeVerificationCodeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetUserAuthFactorsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetUserPoolMfaConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GlobalSignOutCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/InitiateAuthCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDevicesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIdentityProvidersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListResourceServersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTermsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUserImportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUserPoolClientsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUserPoolsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUsersInGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListWebAuthnCredentialsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ResendConfirmationCodeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RespondToAuthChallengeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RevokeTokenCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetLogDeliveryConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetRiskConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUICustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserMFAPreferenceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserPoolMfaConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SignUpCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartUserImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartWebAuthnRegistrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopUserImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAuthEventFeedbackCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDeviceStatusCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIdentityProviderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateManagedLoginBrandingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateResourceServerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTermsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateUserPoolClientCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateUserPoolCommand.d.ts +1 -1
- package/dist-types/ts3.4/index.d.ts +4 -1
- package/dist-types/ts3.4/models/enums.d.ts +372 -0
- package/dist-types/ts3.4/models/errors.d.ts +440 -0
- package/dist-types/ts3.4/models/models_0.d.ts +540 -759
- package/dist-types/ts3.4/models/models_1.d.ts +2 -603
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -2
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/index.d.ts +0 -2
|
@@ -1,3927 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
|
|
4
|
-
import { AccountRecoverySettingType, AccountTakeoverRiskConfigurationType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AssetType, AttributeType, AuthenticationResultType, AuthFactorType, AuthFlowType, ChallengeNameType, CodeDeliveryDetailsType, CompromisedCredentialsRiskConfigurationType, CustomDomainConfigType, DeletionProtectionType, DeviceConfigurationType, DeviceRememberedStatusType, DeviceType, EmailConfigurationType, EmailMfaSettingsType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, IdentityProviderTypeType, LambdaConfigType, LogConfigurationType, LogDeliveryConfigurationType, ManagedLoginBrandingType, MFAOptionType, OAuthFlowType, PreventUserExistenceErrorTypes, RefreshTokenRotationType, ResourceServerScopeType, ResourceServerType, RiskConfigurationType, RiskExceptionConfigurationType, SmsConfigurationType, SMSMfaSettingsType, SoftwareTokenMfaSettingsType, StatusType, TermsEnforcementType, TermsSourceType, TermsType, TokenValidityUnitsType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, UserPoolTierType, UserType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
|
|
5
|
-
/**
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export interface GetTokensFromRefreshTokenResponse {
|
|
9
|
-
/**
|
|
10
|
-
* <p>The object that your application receives after authentication. Contains tokens and
|
|
11
|
-
* information for device authentication.</p>
|
|
12
|
-
* @public
|
|
13
|
-
*/
|
|
14
|
-
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* <p>This exception is throw when your application requests token refresh with a refresh
|
|
18
|
-
* token that has been invalidated by refresh-token rotation.</p>
|
|
19
|
-
* @public
|
|
20
|
-
*/
|
|
21
|
-
export declare class RefreshTokenReuseException extends __BaseException {
|
|
22
|
-
readonly name: "RefreshTokenReuseException";
|
|
23
|
-
readonly $fault: "client";
|
|
24
|
-
/**
|
|
25
|
-
* @internal
|
|
26
|
-
*/
|
|
27
|
-
constructor(opts: __ExceptionOptionType<RefreshTokenReuseException, __BaseException>);
|
|
28
|
-
}
|
|
29
|
-
/**
|
|
30
|
-
* @public
|
|
31
|
-
*/
|
|
32
|
-
export interface GetUICustomizationRequest {
|
|
33
|
-
/**
|
|
34
|
-
* <p>The ID of the user pool that you want to query for branding settings.</p>
|
|
35
|
-
* @public
|
|
36
|
-
*/
|
|
37
|
-
UserPoolId: string | undefined;
|
|
38
|
-
/**
|
|
39
|
-
* <p>The ID of the app client that you want to query for branding settings.</p>
|
|
40
|
-
* @public
|
|
41
|
-
*/
|
|
42
|
-
ClientId?: string | undefined;
|
|
43
|
-
}
|
|
44
|
-
/**
|
|
45
|
-
* <p>A container for the UI customization information for the hosted UI in a user
|
|
46
|
-
* pool.</p>
|
|
47
|
-
* @public
|
|
48
|
-
*/
|
|
49
|
-
export interface UICustomizationType {
|
|
50
|
-
/**
|
|
51
|
-
* <p>The ID of the user pool with hosted UI customizations.</p>
|
|
52
|
-
* @public
|
|
53
|
-
*/
|
|
54
|
-
UserPoolId?: string | undefined;
|
|
55
|
-
/**
|
|
56
|
-
* <p>The app client ID for your UI customization. When this value isn't present, the
|
|
57
|
-
* customization applies to all user pool app clients that don't have client-level
|
|
58
|
-
* settings..</p>
|
|
59
|
-
* @public
|
|
60
|
-
*/
|
|
61
|
-
ClientId?: string | undefined;
|
|
62
|
-
/**
|
|
63
|
-
* <p>A URL path to the hosted logo image of your UI customization.</p>
|
|
64
|
-
* @public
|
|
65
|
-
*/
|
|
66
|
-
ImageUrl?: string | undefined;
|
|
67
|
-
/**
|
|
68
|
-
* <p>The CSS values in the UI customization.</p>
|
|
69
|
-
* @public
|
|
70
|
-
*/
|
|
71
|
-
CSS?: string | undefined;
|
|
72
|
-
/**
|
|
73
|
-
* <p>The CSS version number.</p>
|
|
74
|
-
* @public
|
|
75
|
-
*/
|
|
76
|
-
CSSVersion?: string | undefined;
|
|
77
|
-
/**
|
|
78
|
-
* <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
79
|
-
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
80
|
-
* @public
|
|
81
|
-
*/
|
|
82
|
-
LastModifiedDate?: Date | undefined;
|
|
83
|
-
/**
|
|
84
|
-
* <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
85
|
-
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
86
|
-
* @public
|
|
87
|
-
*/
|
|
88
|
-
CreationDate?: Date | undefined;
|
|
89
|
-
}
|
|
90
|
-
/**
|
|
91
|
-
* @public
|
|
92
|
-
*/
|
|
93
|
-
export interface GetUICustomizationResponse {
|
|
94
|
-
/**
|
|
95
|
-
* <p>Information about the classic hosted UI custom CSS and logo-image branding that you
|
|
96
|
-
* applied to the user pool or app client.</p>
|
|
97
|
-
* @public
|
|
98
|
-
*/
|
|
99
|
-
UICustomization: UICustomizationType | undefined;
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* <p>Represents the request to get information about the user.</p>
|
|
103
|
-
* @public
|
|
104
|
-
*/
|
|
105
|
-
export interface GetUserRequest {
|
|
106
|
-
/**
|
|
107
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
108
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
109
|
-
* @public
|
|
110
|
-
*/
|
|
111
|
-
AccessToken: string | undefined;
|
|
112
|
-
}
|
|
113
|
-
/**
|
|
114
|
-
* <p>Represents the response from the server from the request to get information about the
|
|
115
|
-
* user.</p>
|
|
116
|
-
* @public
|
|
117
|
-
*/
|
|
118
|
-
export interface GetUserResponse {
|
|
119
|
-
/**
|
|
120
|
-
* <p>The name of the user that you requested.</p>
|
|
121
|
-
* @public
|
|
122
|
-
*/
|
|
123
|
-
Username: string | undefined;
|
|
124
|
-
/**
|
|
125
|
-
* <p>An array of name-value pairs representing user attributes.</p>
|
|
126
|
-
* <p>Custom attributes are prepended with the <code>custom:</code> prefix.</p>
|
|
127
|
-
* @public
|
|
128
|
-
*/
|
|
129
|
-
UserAttributes: AttributeType[] | undefined;
|
|
130
|
-
/**
|
|
131
|
-
* <p>
|
|
132
|
-
* <i>This response parameter is no longer supported.</i> It provides
|
|
133
|
-
* information only about SMS MFA configurations. It doesn't provide information about
|
|
134
|
-
* time-based one-time password (TOTP) software token MFA configurations. To look up
|
|
135
|
-
* information about either type of MFA configuration, use UserMFASettingList
|
|
136
|
-
* instead.</p>
|
|
137
|
-
* @public
|
|
138
|
-
*/
|
|
139
|
-
MFAOptions?: MFAOptionType[] | undefined;
|
|
140
|
-
/**
|
|
141
|
-
* <p>The user's preferred MFA. Users can prefer SMS message, email message, or TOTP
|
|
142
|
-
* MFA.</p>
|
|
143
|
-
* @public
|
|
144
|
-
*/
|
|
145
|
-
PreferredMfaSetting?: string | undefined;
|
|
146
|
-
/**
|
|
147
|
-
* <p>The MFA options that are activated for the user. The possible values in this list are
|
|
148
|
-
* <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and
|
|
149
|
-
* <code>SOFTWARE_TOKEN_MFA</code>.</p>
|
|
150
|
-
* @public
|
|
151
|
-
*/
|
|
152
|
-
UserMFASettingList?: string[] | undefined;
|
|
153
|
-
}
|
|
154
|
-
/**
|
|
155
|
-
* <p>Represents the request to get user attribute verification.</p>
|
|
156
|
-
* @public
|
|
157
|
-
*/
|
|
158
|
-
export interface GetUserAttributeVerificationCodeRequest {
|
|
159
|
-
/**
|
|
160
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
161
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
162
|
-
* @public
|
|
163
|
-
*/
|
|
164
|
-
AccessToken: string | undefined;
|
|
165
|
-
/**
|
|
166
|
-
* <p>The name of the attribute that the user wants to verify, for example
|
|
167
|
-
* <code>email</code>.</p>
|
|
168
|
-
* @public
|
|
169
|
-
*/
|
|
170
|
-
AttributeName: string | undefined;
|
|
171
|
-
/**
|
|
172
|
-
* <p>A map of custom key-value pairs that you can provide as input for any custom workflows
|
|
173
|
-
* that this action triggers.</p>
|
|
174
|
-
* <p>You create custom workflows by assigning Lambda functions to user pool
|
|
175
|
-
* triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes
|
|
176
|
-
* the function that is assigned to the <i>custom message</i> trigger. When
|
|
177
|
-
* Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as
|
|
178
|
-
* input. This payload contains a <code>clientMetadata</code> attribute, which provides the
|
|
179
|
-
* data that you assigned to the ClientMetadata parameter in your
|
|
180
|
-
* GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for
|
|
181
|
-
* your specific needs.</p>
|
|
182
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
183
|
-
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
184
|
-
* <note>
|
|
185
|
-
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
186
|
-
* following:</p>
|
|
187
|
-
* <ul>
|
|
188
|
-
* <li>
|
|
189
|
-
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
190
|
-
* to Lambda triggers that are assigned to a user pool to support custom
|
|
191
|
-
* workflows. If your user pool configuration doesn't include triggers, the
|
|
192
|
-
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
193
|
-
* </li>
|
|
194
|
-
* <li>
|
|
195
|
-
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
196
|
-
* </li>
|
|
197
|
-
* <li>
|
|
198
|
-
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
199
|
-
* information in this parameter.</p>
|
|
200
|
-
* </li>
|
|
201
|
-
* </ul>
|
|
202
|
-
* </note>
|
|
203
|
-
* @public
|
|
204
|
-
*/
|
|
205
|
-
ClientMetadata?: Record<string, string> | undefined;
|
|
206
|
-
}
|
|
207
|
-
/**
|
|
208
|
-
* <p>The verification code response returned by the server response to get the user
|
|
209
|
-
* attribute verification code.</p>
|
|
210
|
-
* @public
|
|
211
|
-
*/
|
|
212
|
-
export interface GetUserAttributeVerificationCodeResponse {
|
|
213
|
-
/**
|
|
214
|
-
* <p>Information about the delivery destination of the user attribute verification
|
|
215
|
-
* code.</p>
|
|
216
|
-
* @public
|
|
217
|
-
*/
|
|
218
|
-
CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
|
|
219
|
-
}
|
|
220
|
-
/**
|
|
221
|
-
* @public
|
|
222
|
-
*/
|
|
223
|
-
export interface GetUserAuthFactorsRequest {
|
|
224
|
-
/**
|
|
225
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
226
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
227
|
-
* @public
|
|
228
|
-
*/
|
|
229
|
-
AccessToken: string | undefined;
|
|
230
|
-
}
|
|
231
|
-
/**
|
|
232
|
-
* @public
|
|
233
|
-
*/
|
|
234
|
-
export interface GetUserAuthFactorsResponse {
|
|
235
|
-
/**
|
|
236
|
-
* <p>The name of the user who is eligible for the authentication factors in the
|
|
237
|
-
* response.</p>
|
|
238
|
-
* @public
|
|
239
|
-
*/
|
|
240
|
-
Username: string | undefined;
|
|
241
|
-
/**
|
|
242
|
-
* <p>The challenge method that Amazon Cognito returns to the user in response to sign-in requests.
|
|
243
|
-
* Users can prefer SMS message, email message, or TOTP MFA.</p>
|
|
244
|
-
* @public
|
|
245
|
-
*/
|
|
246
|
-
PreferredMfaSetting?: string | undefined;
|
|
247
|
-
/**
|
|
248
|
-
* <p>The MFA options that are activated for the user. The possible values in this list are
|
|
249
|
-
* <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and
|
|
250
|
-
* <code>SOFTWARE_TOKEN_MFA</code>.</p>
|
|
251
|
-
* @public
|
|
252
|
-
*/
|
|
253
|
-
UserMFASettingList?: string[] | undefined;
|
|
254
|
-
/**
|
|
255
|
-
* <p>The authentication types that are available to the user with <code>USER_AUTH</code>
|
|
256
|
-
* sign-in, for example <code>["PASSWORD", "WEB_AUTHN"]</code>.</p>
|
|
257
|
-
* @public
|
|
258
|
-
*/
|
|
259
|
-
ConfiguredUserAuthFactors?: AuthFactorType[] | undefined;
|
|
260
|
-
}
|
|
261
|
-
/**
|
|
262
|
-
* @public
|
|
263
|
-
*/
|
|
264
|
-
export interface GetUserPoolMfaConfigRequest {
|
|
265
|
-
/**
|
|
266
|
-
* <p>The ID of the user pool where you want to query WebAuthn and MFA configuration.</p>
|
|
267
|
-
* @public
|
|
268
|
-
*/
|
|
269
|
-
UserPoolId: string | undefined;
|
|
270
|
-
}
|
|
271
|
-
/**
|
|
272
|
-
* <p>Sets or shows configuration for user pool email message MFA and sign-in with one-time
|
|
273
|
-
* passwords (OTPs). Includes the subject and body of the email message template for
|
|
274
|
-
* sign-in and MFA messages. 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">
|
|
275
|
-
* Essentials tier</a> or higher.</p>
|
|
276
|
-
* @public
|
|
277
|
-
*/
|
|
278
|
-
export interface EmailMfaConfigType {
|
|
279
|
-
/**
|
|
280
|
-
* <p>The template for the email messages that your user pool sends to users with codes for
|
|
281
|
-
* MFA and sign-in with email OTPs. The message must contain the <code>\{####\}</code>
|
|
282
|
-
* placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you
|
|
283
|
-
* don't provide this parameter, Amazon Cognito sends messages in the default format.</p>
|
|
284
|
-
* @public
|
|
285
|
-
*/
|
|
286
|
-
Message?: string | undefined;
|
|
287
|
-
/**
|
|
288
|
-
* <p>The subject of the email messages that your user pool sends to users with codes for
|
|
289
|
-
* MFA and email OTP sign-in.</p>
|
|
290
|
-
* @public
|
|
291
|
-
*/
|
|
292
|
-
Subject?: string | undefined;
|
|
293
|
-
}
|
|
294
|
-
/**
|
|
295
|
-
* <p>The configuration of multi-factor authentication (MFA) with SMS messages in a user
|
|
296
|
-
* pool.</p>
|
|
297
|
-
* @public
|
|
298
|
-
*/
|
|
299
|
-
export interface SmsMfaConfigType {
|
|
300
|
-
/**
|
|
301
|
-
* <p>The SMS authentication message that will be sent to users with the code they must sign
|
|
302
|
-
* in with. The message must contain the <code>\{####\}</code> placeholder. Your user pool
|
|
303
|
-
* replaces the placeholder with the MFA code. If this parameter isn't provided, your user
|
|
304
|
-
* pool sends a default message.</p>
|
|
305
|
-
* @public
|
|
306
|
-
*/
|
|
307
|
-
SmsAuthenticationMessage?: string | undefined;
|
|
308
|
-
/**
|
|
309
|
-
* <p>User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS
|
|
310
|
-
* messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an
|
|
311
|
-
* Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
|
|
312
|
-
* <p>You can set <code>SmsConfiguration</code> in <code>CreateUserPool</code> and <code>
|
|
313
|
-
* UpdateUserPool</code>, or in <code>SetUserPoolMfaConfig</code>.</p>
|
|
314
|
-
* @public
|
|
315
|
-
*/
|
|
316
|
-
SmsConfiguration?: SmsConfigurationType | undefined;
|
|
317
|
-
}
|
|
318
|
-
/**
|
|
319
|
-
* <p>Settings for time-based one-time password (TOTP) multi-factor authentication (MFA) in
|
|
320
|
-
* a user pool. Enables and disables availability of this feature.</p>
|
|
321
|
-
* @public
|
|
322
|
-
*/
|
|
323
|
-
export interface SoftwareTokenMfaConfigType {
|
|
324
|
-
/**
|
|
325
|
-
* <p>The activation state of TOTP MFA.</p>
|
|
326
|
-
* @public
|
|
327
|
-
*/
|
|
328
|
-
Enabled?: boolean | undefined;
|
|
329
|
-
}
|
|
330
|
-
/**
|
|
331
|
-
* @public
|
|
332
|
-
* @enum
|
|
333
|
-
*/
|
|
334
|
-
export declare const UserVerificationType: {
|
|
335
|
-
readonly PREFERRED: "preferred";
|
|
336
|
-
readonly REQUIRED: "required";
|
|
337
|
-
};
|
|
338
|
-
/**
|
|
339
|
-
* @public
|
|
340
|
-
*/
|
|
341
|
-
export type UserVerificationType = (typeof UserVerificationType)[keyof typeof UserVerificationType];
|
|
342
|
-
/**
|
|
343
|
-
* <p>Settings for authentication (MFA) with passkey, or webauthN, biometric and
|
|
344
|
-
* security-key devices in a user pool. Configures the following:</p>
|
|
345
|
-
* <ul>
|
|
346
|
-
* <li>
|
|
347
|
-
* <p>Configuration for requiring user-verification support in passkeys.</p>
|
|
348
|
-
* </li>
|
|
349
|
-
* <li>
|
|
350
|
-
* <p>The user pool relying-party ID. This is the domain, typically your user pool
|
|
351
|
-
* domain, that user's passkey providers should trust as a receiver of passkey
|
|
352
|
-
* authentication.</p>
|
|
353
|
-
* </li>
|
|
354
|
-
* <li>
|
|
355
|
-
* <p>The providers that you want to allow as origins for passkey
|
|
356
|
-
* authentication.</p>
|
|
357
|
-
* </li>
|
|
358
|
-
* </ul>
|
|
359
|
-
* @public
|
|
360
|
-
*/
|
|
361
|
-
export interface WebAuthnConfigurationType {
|
|
362
|
-
/**
|
|
363
|
-
* <p>Sets or displays the authentication domain, typically your user pool domain, that
|
|
364
|
-
* passkey providers must use as a relying party (RP) in their configuration.</p>
|
|
365
|
-
* <p>Under the following conditions, the passkey relying party ID must be the
|
|
366
|
-
* fully-qualified domain name of your custom domain:</p>
|
|
367
|
-
* <ul>
|
|
368
|
-
* <li>
|
|
369
|
-
* <p>The user pool is configured for passkey authentication.</p>
|
|
370
|
-
* </li>
|
|
371
|
-
* <li>
|
|
372
|
-
* <p>The user pool has a custom domain, whether or not it also has a prefix
|
|
373
|
-
* domain.</p>
|
|
374
|
-
* </li>
|
|
375
|
-
* <li>
|
|
376
|
-
* <p>Your application performs authentication with managed login or the classic
|
|
377
|
-
* hosted UI.</p>
|
|
378
|
-
* </li>
|
|
379
|
-
* </ul>
|
|
380
|
-
* @public
|
|
381
|
-
*/
|
|
382
|
-
RelyingPartyId?: string | undefined;
|
|
383
|
-
/**
|
|
384
|
-
* <p>When <code>required</code>, users can only register and sign in users with passkeys
|
|
385
|
-
* that are capable of <a href="https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement">user
|
|
386
|
-
* verification</a>. When <code>preferred</code>, your user pool doesn't
|
|
387
|
-
* require the use of authenticators with user verification but encourages it.</p>
|
|
388
|
-
* @public
|
|
389
|
-
*/
|
|
390
|
-
UserVerification?: UserVerificationType | undefined;
|
|
391
|
-
}
|
|
392
|
-
/**
|
|
393
|
-
* @public
|
|
394
|
-
*/
|
|
395
|
-
export interface GetUserPoolMfaConfigResponse {
|
|
396
|
-
/**
|
|
397
|
-
* <p>Shows user pool configuration for SMS message MFA. Includes the message template and
|
|
398
|
-
* the SMS message sending configuration for Amazon SNS.</p>
|
|
399
|
-
* @public
|
|
400
|
-
*/
|
|
401
|
-
SmsMfaConfiguration?: SmsMfaConfigType | undefined;
|
|
402
|
-
/**
|
|
403
|
-
* <p>Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes
|
|
404
|
-
* TOTP enabled or disabled state.</p>
|
|
405
|
-
* @public
|
|
406
|
-
*/
|
|
407
|
-
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
|
|
408
|
-
/**
|
|
409
|
-
* <p>Shows configuration for user pool email message MFA and sign-in with one-time
|
|
410
|
-
* passwords (OTPs). Includes the subject and body of the email message template for
|
|
411
|
-
* sign-in and MFA messages. 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">
|
|
412
|
-
* Essentials tier</a> or higher.</p>
|
|
413
|
-
* @public
|
|
414
|
-
*/
|
|
415
|
-
EmailMfaConfiguration?: EmailMfaConfigType | undefined;
|
|
416
|
-
/**
|
|
417
|
-
* <p>Displays the state of multi-factor authentication (MFA) as on, off, or optional. When
|
|
418
|
-
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
419
|
-
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
420
|
-
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
421
|
-
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
422
|
-
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
423
|
-
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
424
|
-
* API responses and in managed login for users who have chosen and configured a preferred
|
|
425
|
-
* MFA factor.</p>
|
|
426
|
-
* @public
|
|
427
|
-
*/
|
|
428
|
-
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
429
|
-
/**
|
|
430
|
-
* <p>Shows user pool configuration for sign-in with passkey authenticators like biometric
|
|
431
|
-
* devices and security keys. Passkeys are not eligible MFA factors. They are instead an
|
|
432
|
-
* eligible primary sign-in factor for <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a>, or the
|
|
433
|
-
* <code>USER_AUTH</code> flow.</p>
|
|
434
|
-
* @public
|
|
435
|
-
*/
|
|
436
|
-
WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
|
|
437
|
-
}
|
|
438
|
-
/**
|
|
439
|
-
* <p>Represents the request to sign out all devices.</p>
|
|
440
|
-
* @public
|
|
441
|
-
*/
|
|
442
|
-
export interface GlobalSignOutRequest {
|
|
443
|
-
/**
|
|
444
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
445
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
446
|
-
* @public
|
|
447
|
-
*/
|
|
448
|
-
AccessToken: string | undefined;
|
|
449
|
-
}
|
|
450
|
-
/**
|
|
451
|
-
* <p>The response to the request to sign out all devices.</p>
|
|
452
|
-
* @public
|
|
453
|
-
*/
|
|
454
|
-
export interface GlobalSignOutResponse {
|
|
455
|
-
}
|
|
456
|
-
/**
|
|
457
|
-
* <p>Initiates the authentication request.</p>
|
|
458
|
-
* @public
|
|
459
|
-
*/
|
|
460
|
-
export interface InitiateAuthRequest {
|
|
461
|
-
/**
|
|
462
|
-
* <p>The authentication flow that you want to initiate. Each <code>AuthFlow</code> has
|
|
463
|
-
* linked <code>AuthParameters</code> that you must submit. The following are some example
|
|
464
|
-
* flows.</p>
|
|
465
|
-
* <dl>
|
|
466
|
-
* <dt>USER_AUTH</dt>
|
|
467
|
-
* <dd>
|
|
468
|
-
* <p>The entry point for <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a> with passwords,
|
|
469
|
-
* one-time passwords, and WebAuthn authenticators. Request a preferred
|
|
470
|
-
* authentication type or review available authentication types. From the
|
|
471
|
-
* offered authentication types, select one in a challenge response and then
|
|
472
|
-
* authenticate with that method in an additional challenge response.
|
|
473
|
-
* 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">
|
|
474
|
-
* Essentials tier</a> or higher.</p>
|
|
475
|
-
* </dd>
|
|
476
|
-
* <dt>USER_SRP_AUTH</dt>
|
|
477
|
-
* <dd>
|
|
478
|
-
* <p>Username-password authentication with the Secure Remote Password (SRP)
|
|
479
|
-
* protocol. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#Using-SRP-password-verification-in-custom-authentication-flow">Use SRP password verification in custom
|
|
480
|
-
* authentication flow</a>.</p>
|
|
481
|
-
* </dd>
|
|
482
|
-
* <dt>REFRESH_TOKEN_AUTH and REFRESH_TOKEN</dt>
|
|
483
|
-
* <dd>
|
|
484
|
-
* <p>Receive new ID and access tokens when you pass a
|
|
485
|
-
* <code>REFRESH_TOKEN</code> parameter with a valid refresh token as the
|
|
486
|
-
* value. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-refresh-token.html">Using the refresh token</a>.</p>
|
|
487
|
-
* </dd>
|
|
488
|
-
* <dt>CUSTOM_AUTH</dt>
|
|
489
|
-
* <dd>
|
|
490
|
-
* <p>Custom authentication with Lambda triggers. For more information, see
|
|
491
|
-
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html">Custom authentication challenge Lambda
|
|
492
|
-
* triggers</a>.</p>
|
|
493
|
-
* </dd>
|
|
494
|
-
* <dt>USER_PASSWORD_AUTH</dt>
|
|
495
|
-
* <dd>
|
|
496
|
-
* <p>Client-side username-password authentication with the password sent
|
|
497
|
-
* directly in the request. For more information about client-side and
|
|
498
|
-
* server-side authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-public-server-side.html">SDK authorization models</a>.</p>
|
|
499
|
-
* </dd>
|
|
500
|
-
* </dl>
|
|
501
|
-
* <p>
|
|
502
|
-
* <code>ADMIN_USER_PASSWORD_AUTH</code> is a flow type of <code>AdminInitiateAuth</code>
|
|
503
|
-
* and isn't valid for InitiateAuth. <code>ADMIN_NO_SRP_AUTH</code> is a legacy server-side
|
|
504
|
-
* username-password flow and isn't valid for InitiateAuth.</p>
|
|
505
|
-
* @public
|
|
506
|
-
*/
|
|
507
|
-
AuthFlow: AuthFlowType | undefined;
|
|
508
|
-
/**
|
|
509
|
-
* <p>The authentication parameters. These are inputs corresponding to the
|
|
510
|
-
* <code>AuthFlow</code> that you're invoking.</p>
|
|
511
|
-
* <p>The following are some authentication flows and their parameters. Add a
|
|
512
|
-
* <code>SECRET_HASH</code> parameter if your app client has a client secret. Add
|
|
513
|
-
* <code>DEVICE_KEY</code> if you want to bypass multi-factor authentication with a
|
|
514
|
-
* remembered device. </p>
|
|
515
|
-
* <dl>
|
|
516
|
-
* <dt>USER_AUTH</dt>
|
|
517
|
-
* <dd>
|
|
518
|
-
* <ul>
|
|
519
|
-
* <li>
|
|
520
|
-
* <p>
|
|
521
|
-
* <code>USERNAME</code> (required)</p>
|
|
522
|
-
* </li>
|
|
523
|
-
* <li>
|
|
524
|
-
* <p>
|
|
525
|
-
* <code>PREFERRED_CHALLENGE</code>. If you don't provide a
|
|
526
|
-
* value for <code>PREFERRED_CHALLENGE</code>, Amazon Cognito responds with the
|
|
527
|
-
* <code>AvailableChallenges</code> parameter that specifies the
|
|
528
|
-
* available sign-in methods.</p>
|
|
529
|
-
* </li>
|
|
530
|
-
* </ul>
|
|
531
|
-
* </dd>
|
|
532
|
-
* <dt>USER_SRP_AUTH</dt>
|
|
533
|
-
* <dd>
|
|
534
|
-
* <ul>
|
|
535
|
-
* <li>
|
|
536
|
-
* <p>
|
|
537
|
-
* <code>USERNAME</code> (required)</p>
|
|
538
|
-
* </li>
|
|
539
|
-
* <li>
|
|
540
|
-
* <p>
|
|
541
|
-
* <code>SRP_A</code> (required)</p>
|
|
542
|
-
* </li>
|
|
543
|
-
* </ul>
|
|
544
|
-
* </dd>
|
|
545
|
-
* <dt>USER_PASSWORD_AUTH</dt>
|
|
546
|
-
* <dd>
|
|
547
|
-
* <ul>
|
|
548
|
-
* <li>
|
|
549
|
-
* <p>
|
|
550
|
-
* <code>USERNAME</code> (required)</p>
|
|
551
|
-
* </li>
|
|
552
|
-
* <li>
|
|
553
|
-
* <p>
|
|
554
|
-
* <code>PASSWORD</code> (required)</p>
|
|
555
|
-
* </li>
|
|
556
|
-
* </ul>
|
|
557
|
-
* </dd>
|
|
558
|
-
* <dt>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</dt>
|
|
559
|
-
* <dd>
|
|
560
|
-
* <ul>
|
|
561
|
-
* <li>
|
|
562
|
-
* <p>
|
|
563
|
-
* <code>REFRESH_TOKEN</code>(required)</p>
|
|
564
|
-
* </li>
|
|
565
|
-
* </ul>
|
|
566
|
-
* </dd>
|
|
567
|
-
* <dt>CUSTOM_AUTH</dt>
|
|
568
|
-
* <dd>
|
|
569
|
-
* <ul>
|
|
570
|
-
* <li>
|
|
571
|
-
* <p>
|
|
572
|
-
* <code>USERNAME</code> (required)</p>
|
|
573
|
-
* </li>
|
|
574
|
-
* <li>
|
|
575
|
-
* <p>
|
|
576
|
-
* <code>ChallengeName: SRP_A</code> (when doing SRP authentication
|
|
577
|
-
* before custom challenges)</p>
|
|
578
|
-
* </li>
|
|
579
|
-
* <li>
|
|
580
|
-
* <p>
|
|
581
|
-
* <code>SRP_A: (An SRP_A value)</code> (when doing SRP
|
|
582
|
-
* authentication before custom challenges)</p>
|
|
583
|
-
* </li>
|
|
584
|
-
* </ul>
|
|
585
|
-
* </dd>
|
|
586
|
-
* </dl>
|
|
587
|
-
* <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
|
|
588
|
-
* <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
589
|
-
* @public
|
|
590
|
-
*/
|
|
591
|
-
AuthParameters?: Record<string, string> | undefined;
|
|
592
|
-
/**
|
|
593
|
-
* <p>A map of custom key-value pairs that you can provide as input for certain custom
|
|
594
|
-
* workflows that this action triggers.</p>
|
|
595
|
-
* <p>You create custom workflows by assigning Lambda functions to user pool triggers.
|
|
596
|
-
* When you send an <code>InitiateAuth</code> request, Amazon Cognito invokes the Lambda functions
|
|
597
|
-
* that are specified for various triggers. The <code>ClientMetadata</code> value is passed
|
|
598
|
-
* as input to the functions for only the following triggers.</p>
|
|
599
|
-
* <ul>
|
|
600
|
-
* <li>
|
|
601
|
-
* <p>Pre sign-up</p>
|
|
602
|
-
* </li>
|
|
603
|
-
* <li>
|
|
604
|
-
* <p>Pre authentication</p>
|
|
605
|
-
* </li>
|
|
606
|
-
* <li>
|
|
607
|
-
* <p>User migration</p>
|
|
608
|
-
* </li>
|
|
609
|
-
* </ul>
|
|
610
|
-
* <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload as input
|
|
611
|
-
* to the function. This payload contains a <code>validationData</code> attribute with the
|
|
612
|
-
* data that you assigned to the <code>ClientMetadata</code> parameter in your
|
|
613
|
-
* <code>InitiateAuth</code> request. In your function, <code>validationData</code> can
|
|
614
|
-
* contribute to operations that require data that isn't in the default
|
|
615
|
-
* payload.</p>
|
|
616
|
-
* <p>
|
|
617
|
-
* <code>InitiateAuth</code> requests invokes the following triggers without
|
|
618
|
-
* <code>ClientMetadata</code> as input.</p>
|
|
619
|
-
* <ul>
|
|
620
|
-
* <li>
|
|
621
|
-
* <p>Post authentication</p>
|
|
622
|
-
* </li>
|
|
623
|
-
* <li>
|
|
624
|
-
* <p>Custom message</p>
|
|
625
|
-
* </li>
|
|
626
|
-
* <li>
|
|
627
|
-
* <p>Pre token generation</p>
|
|
628
|
-
* </li>
|
|
629
|
-
* <li>
|
|
630
|
-
* <p>Create auth challenge</p>
|
|
631
|
-
* </li>
|
|
632
|
-
* <li>
|
|
633
|
-
* <p>Define auth challenge</p>
|
|
634
|
-
* </li>
|
|
635
|
-
* <li>
|
|
636
|
-
* <p>Custom email sender</p>
|
|
637
|
-
* </li>
|
|
638
|
-
* <li>
|
|
639
|
-
* <p>Custom SMS sender</p>
|
|
640
|
-
* </li>
|
|
641
|
-
* </ul>
|
|
642
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
643
|
-
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
644
|
-
* <note>
|
|
645
|
-
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
646
|
-
* following:</p>
|
|
647
|
-
* <ul>
|
|
648
|
-
* <li>
|
|
649
|
-
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
650
|
-
* to Lambda triggers that are assigned to a user pool to support custom
|
|
651
|
-
* workflows. If your user pool configuration doesn't include triggers, the
|
|
652
|
-
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
653
|
-
* </li>
|
|
654
|
-
* <li>
|
|
655
|
-
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
656
|
-
* </li>
|
|
657
|
-
* <li>
|
|
658
|
-
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
659
|
-
* information in this parameter.</p>
|
|
660
|
-
* </li>
|
|
661
|
-
* </ul>
|
|
662
|
-
* </note>
|
|
663
|
-
* @public
|
|
664
|
-
*/
|
|
665
|
-
ClientMetadata?: Record<string, string> | undefined;
|
|
666
|
-
/**
|
|
667
|
-
* <p>The ID of the app client that your user wants to sign in to.</p>
|
|
668
|
-
* @public
|
|
669
|
-
*/
|
|
670
|
-
ClientId: string | undefined;
|
|
671
|
-
/**
|
|
672
|
-
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
673
|
-
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
674
|
-
* email address, or phone number.</p>
|
|
675
|
-
* @public
|
|
676
|
-
*/
|
|
677
|
-
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
678
|
-
/**
|
|
679
|
-
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
680
|
-
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
681
|
-
* when it makes API requests.</p>
|
|
682
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
683
|
-
* applications</a>.</p>
|
|
684
|
-
* @public
|
|
685
|
-
*/
|
|
686
|
-
UserContextData?: UserContextDataType | undefined;
|
|
687
|
-
/**
|
|
688
|
-
* <p>The optional session ID from a <code>ConfirmSignUp</code> API request. You can sign in
|
|
689
|
-
* a user directly from the sign-up process with the <code>USER_AUTH</code> authentication
|
|
690
|
-
* flow. When you pass the session ID to <code>InitiateAuth</code>, Amazon Cognito assumes the SMS
|
|
691
|
-
* or email message one-time verification password from <code>ConfirmSignUp</code> as the
|
|
692
|
-
* primary authentication factor. You're not required to submit this code a second
|
|
693
|
-
* time. This option is only valid for users who have confirmed their sign-up and are
|
|
694
|
-
* signing in for the first time within the authentication flow session duration of the
|
|
695
|
-
* session ID.</p>
|
|
696
|
-
* @public
|
|
697
|
-
*/
|
|
698
|
-
Session?: string | undefined;
|
|
699
|
-
}
|
|
700
|
-
/**
|
|
701
|
-
* <p>Initiates the authentication response.</p>
|
|
702
|
-
* @public
|
|
703
|
-
*/
|
|
704
|
-
export interface InitiateAuthResponse {
|
|
705
|
-
/**
|
|
706
|
-
* <p>The name of an additional authentication challenge that you must respond to.</p>
|
|
707
|
-
* <p>Possible challenges include the following:</p>
|
|
708
|
-
* <note>
|
|
709
|
-
* <p>All of the following challenges require <code>USERNAME</code> and, when the app
|
|
710
|
-
* client has a client secret, <code>SECRET_HASH</code> in the parameters. Include a
|
|
711
|
-
* <code>DEVICE_KEY</code> for device authentication.</p>
|
|
712
|
-
* </note>
|
|
713
|
-
* <ul>
|
|
714
|
-
* <li>
|
|
715
|
-
* <p>
|
|
716
|
-
* <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
|
|
717
|
-
* successful authentication with a WebAuthn authenticator, or passkey, as
|
|
718
|
-
* <code>CREDENTIAL</code>. Examples of WebAuthn authenticators include
|
|
719
|
-
* biometric devices and security keys.</p>
|
|
720
|
-
* </li>
|
|
721
|
-
* <li>
|
|
722
|
-
* <p>
|
|
723
|
-
* <code>PASSWORD</code>: Respond with the user's password as <code>PASSWORD</code>.</p>
|
|
724
|
-
* </li>
|
|
725
|
-
* <li>
|
|
726
|
-
* <p>
|
|
727
|
-
* <code>PASSWORD_SRP</code>: Respond with the initial SRP secret as <code>SRP_A</code>.</p>
|
|
728
|
-
* </li>
|
|
729
|
-
* <li>
|
|
730
|
-
* <p>
|
|
731
|
-
* <code>SELECT_CHALLENGE</code>: Respond with a challenge selection as <code>ANSWER</code>.
|
|
732
|
-
* It must be one of the challenge types in the <code>AvailableChallenges</code> response
|
|
733
|
-
* parameter. Add the parameters of the selected challenge, for example <code>USERNAME</code>
|
|
734
|
-
* and <code>SMS_OTP</code>.</p>
|
|
735
|
-
* </li>
|
|
736
|
-
* <li>
|
|
737
|
-
* <p>
|
|
738
|
-
* <code>SMS_MFA</code>: Respond with the code that your user pool delivered in an SMS
|
|
739
|
-
* message, as <code>SMS_MFA_CODE</code>
|
|
740
|
-
* </p>
|
|
741
|
-
* </li>
|
|
742
|
-
* <li>
|
|
743
|
-
* <p>
|
|
744
|
-
* <code>EMAIL_MFA</code>: Respond with the code that your user pool delivered in an email
|
|
745
|
-
* message, as <code>EMAIL_MFA_CODE</code>
|
|
746
|
-
* </p>
|
|
747
|
-
* </li>
|
|
748
|
-
* <li>
|
|
749
|
-
* <p>
|
|
750
|
-
* <code>EMAIL_OTP</code>: Respond with the code that your user pool delivered in an email
|
|
751
|
-
* message, as <code>EMAIL_OTP_CODE</code> .</p>
|
|
752
|
-
* </li>
|
|
753
|
-
* <li>
|
|
754
|
-
* <p>
|
|
755
|
-
* <code>SMS_OTP</code>: Respond with the code that your user pool delivered in an SMS
|
|
756
|
-
* message, as <code>SMS_OTP_CODE</code>.</p>
|
|
757
|
-
* </li>
|
|
758
|
-
* <li>
|
|
759
|
-
* <p>
|
|
760
|
-
* <code>PASSWORD_VERIFIER</code>: Respond with the second stage of SRP secrets as
|
|
761
|
-
* <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>,
|
|
762
|
-
* and <code>TIMESTAMP</code>.</p>
|
|
763
|
-
* </li>
|
|
764
|
-
* <li>
|
|
765
|
-
* <p>
|
|
766
|
-
* <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
|
|
767
|
-
* flow determines that the user should pass another challenge before tokens are
|
|
768
|
-
* issued. The parameters of the challenge are determined by your Lambda function
|
|
769
|
-
* and issued in the <code>ChallengeParameters</code> of a challenge response.</p>
|
|
770
|
-
* </li>
|
|
771
|
-
* <li>
|
|
772
|
-
* <p>
|
|
773
|
-
* <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
|
|
774
|
-
* authentication. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
775
|
-
* </li>
|
|
776
|
-
* <li>
|
|
777
|
-
* <p>
|
|
778
|
-
* <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
|
|
779
|
-
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
780
|
-
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
781
|
-
* client-side SRP calculations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
782
|
-
* </li>
|
|
783
|
-
* <li>
|
|
784
|
-
* <p>
|
|
785
|
-
* <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
|
|
786
|
-
* passwords after successful first login. Respond to this challenge with
|
|
787
|
-
* <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
|
|
788
|
-
* the <code>requiredAttributes</code> parameter. You can also set values for
|
|
789
|
-
* attributes that aren't required by your user pool and that your app client
|
|
790
|
-
* can write.</p>
|
|
791
|
-
* <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
|
|
792
|
-
* When you create passwordless users, you must provide values for all required
|
|
793
|
-
* attributes.</p>
|
|
794
|
-
* <note>
|
|
795
|
-
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
796
|
-
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
797
|
-
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
798
|
-
* operation to modify the value of any additional attributes.</p>
|
|
799
|
-
* </note>
|
|
800
|
-
* </li>
|
|
801
|
-
* <li>
|
|
802
|
-
* <p>
|
|
803
|
-
* <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
|
|
804
|
-
* before they can sign in. The MFA types activated for the user pool will be
|
|
805
|
-
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
806
|
-
* <p>To set up time-based one-time password (TOTP) MFA, use the session returned
|
|
807
|
-
* in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
|
|
808
|
-
* as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
|
|
809
|
-
* by <code>VerifySoftwareToken</code> as an input to
|
|
810
|
-
* <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
|
|
811
|
-
* with challenge name <code>MFA_SETUP</code> to complete sign-in.
|
|
812
|
-
* </p>
|
|
813
|
-
* <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
|
|
814
|
-
* <code>email</code> attribute for the user. Then restart the authentication
|
|
815
|
-
* flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
|
|
816
|
-
* </p>
|
|
817
|
-
* </li>
|
|
818
|
-
* </ul>
|
|
819
|
-
* @public
|
|
820
|
-
*/
|
|
821
|
-
ChallengeName?: ChallengeNameType | undefined;
|
|
822
|
-
/**
|
|
823
|
-
* <p>The session identifier that links a challenge response to the initial authentication
|
|
824
|
-
* request. If the user must pass another challenge, Amazon Cognito returns a session ID and
|
|
825
|
-
* challenge parameters.</p>
|
|
826
|
-
* @public
|
|
827
|
-
*/
|
|
828
|
-
Session?: string | undefined;
|
|
829
|
-
/**
|
|
830
|
-
* <p>The required parameters of the <code>ChallengeName</code> challenge.</p>
|
|
831
|
-
* <p>All challenges require <code>USERNAME</code>. They also require
|
|
832
|
-
* <code>SECRET_HASH</code> if your app client has a client secret.</p>
|
|
833
|
-
* @public
|
|
834
|
-
*/
|
|
835
|
-
ChallengeParameters?: Record<string, string> | undefined;
|
|
836
|
-
/**
|
|
837
|
-
* <p>The result of a successful and complete authentication request. This result is only
|
|
838
|
-
* returned if the user doesn't need to pass another challenge. If they must pass another
|
|
839
|
-
* challenge before they get tokens, Amazon Cognito returns a challenge in
|
|
840
|
-
* <code>ChallengeName</code>, <code>ChallengeParameters</code>, and
|
|
841
|
-
* <code>Session</code> response parameters.</p>
|
|
842
|
-
* @public
|
|
843
|
-
*/
|
|
844
|
-
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
845
|
-
/**
|
|
846
|
-
* <p>This response parameter lists the available authentication challenges that users can
|
|
847
|
-
* select from in <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a>. For example, they might be
|
|
848
|
-
* able to choose between passkey authentication, a one-time password from an SMS message,
|
|
849
|
-
* and a traditional password.</p>
|
|
850
|
-
* @public
|
|
851
|
-
*/
|
|
852
|
-
AvailableChallenges?: ChallengeNameType[] | undefined;
|
|
853
|
-
}
|
|
854
|
-
/**
|
|
855
|
-
* <p>Represents the request to list the devices.</p>
|
|
856
|
-
* @public
|
|
857
|
-
*/
|
|
858
|
-
export interface ListDevicesRequest {
|
|
859
|
-
/**
|
|
860
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
861
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
862
|
-
* @public
|
|
863
|
-
*/
|
|
864
|
-
AccessToken: string | undefined;
|
|
865
|
-
/**
|
|
866
|
-
* <p>The maximum number of devices that you want Amazon Cognito to return in the response.</p>
|
|
867
|
-
* @public
|
|
868
|
-
*/
|
|
869
|
-
Limit?: number | undefined;
|
|
870
|
-
/**
|
|
871
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
872
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
873
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
874
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
875
|
-
* through the full list of items.</p>
|
|
876
|
-
* @public
|
|
877
|
-
*/
|
|
878
|
-
PaginationToken?: string | undefined;
|
|
879
|
-
}
|
|
880
|
-
/**
|
|
881
|
-
* <p>Represents the response to list devices.</p>
|
|
882
|
-
* @public
|
|
883
|
-
*/
|
|
884
|
-
export interface ListDevicesResponse {
|
|
885
|
-
/**
|
|
886
|
-
* <p>An array of devices and their details. Each entry that's returned includes device
|
|
887
|
-
* information, last-accessed and created dates, and the device key.</p>
|
|
888
|
-
* @public
|
|
889
|
-
*/
|
|
890
|
-
Devices?: DeviceType[] | undefined;
|
|
891
|
-
/**
|
|
892
|
-
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
893
|
-
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
894
|
-
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
895
|
-
* @public
|
|
896
|
-
*/
|
|
897
|
-
PaginationToken?: string | undefined;
|
|
898
|
-
}
|
|
899
|
-
/**
|
|
900
|
-
* @public
|
|
901
|
-
*/
|
|
902
|
-
export interface ListGroupsRequest {
|
|
903
|
-
/**
|
|
904
|
-
* <p>The ID of the user pool where you want to list user groups.</p>
|
|
905
|
-
* @public
|
|
906
|
-
*/
|
|
907
|
-
UserPoolId: string | undefined;
|
|
908
|
-
/**
|
|
909
|
-
* <p>The maximum number of groups that you want Amazon Cognito to return in the response.</p>
|
|
910
|
-
* @public
|
|
911
|
-
*/
|
|
912
|
-
Limit?: number | undefined;
|
|
913
|
-
/**
|
|
914
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
915
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
916
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
917
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
918
|
-
* through the full list of items.</p>
|
|
919
|
-
* @public
|
|
920
|
-
*/
|
|
921
|
-
NextToken?: string | undefined;
|
|
922
|
-
}
|
|
923
|
-
/**
|
|
924
|
-
* @public
|
|
925
|
-
*/
|
|
926
|
-
export interface ListGroupsResponse {
|
|
927
|
-
/**
|
|
928
|
-
* <p>An array of groups and their details. Each entry that's returned includes
|
|
929
|
-
* description, precedence, and IAM role values.</p>
|
|
930
|
-
* @public
|
|
931
|
-
*/
|
|
932
|
-
Groups?: GroupType[] | undefined;
|
|
933
|
-
/**
|
|
934
|
-
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
935
|
-
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
936
|
-
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
937
|
-
* @public
|
|
938
|
-
*/
|
|
939
|
-
NextToken?: string | undefined;
|
|
940
|
-
}
|
|
941
|
-
/**
|
|
942
|
-
* @public
|
|
943
|
-
*/
|
|
944
|
-
export interface ListIdentityProvidersRequest {
|
|
945
|
-
/**
|
|
946
|
-
* <p>The ID of the user pool where you want to list IdPs.</p>
|
|
947
|
-
* @public
|
|
948
|
-
*/
|
|
949
|
-
UserPoolId: string | undefined;
|
|
950
|
-
/**
|
|
951
|
-
* <p>The maximum number of IdPs that you want Amazon Cognito to return in the response.</p>
|
|
952
|
-
* @public
|
|
953
|
-
*/
|
|
954
|
-
MaxResults?: number | undefined;
|
|
955
|
-
/**
|
|
956
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
957
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
958
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
959
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
960
|
-
* through the full list of items.</p>
|
|
961
|
-
* @public
|
|
962
|
-
*/
|
|
963
|
-
NextToken?: string | undefined;
|
|
964
|
-
}
|
|
965
|
-
/**
|
|
966
|
-
* <p>The details of a user pool identity provider (IdP), including name and type.</p>
|
|
967
|
-
* @public
|
|
968
|
-
*/
|
|
969
|
-
export interface ProviderDescription {
|
|
970
|
-
/**
|
|
971
|
-
* <p>The name of the IdP, for example <code>MySAMLProvider</code>.</p>
|
|
972
|
-
* @public
|
|
973
|
-
*/
|
|
974
|
-
ProviderName?: string | undefined;
|
|
975
|
-
/**
|
|
976
|
-
* <p>The type of the provider, for example <code>SAML</code>. Amazon Cognito supports SAML 2.0,
|
|
977
|
-
* OIDC, and social IdPs. User pools list supported social IdPs by name in this response
|
|
978
|
-
* parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.</p>
|
|
979
|
-
* @public
|
|
980
|
-
*/
|
|
981
|
-
ProviderType?: IdentityProviderTypeType | undefined;
|
|
982
|
-
/**
|
|
983
|
-
* <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
984
|
-
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
985
|
-
* @public
|
|
986
|
-
*/
|
|
987
|
-
LastModifiedDate?: Date | undefined;
|
|
988
|
-
/**
|
|
989
|
-
* <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
990
|
-
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
991
|
-
* @public
|
|
992
|
-
*/
|
|
993
|
-
CreationDate?: Date | undefined;
|
|
994
|
-
}
|
|
995
|
-
/**
|
|
996
|
-
* @public
|
|
997
|
-
*/
|
|
998
|
-
export interface ListIdentityProvidersResponse {
|
|
999
|
-
/**
|
|
1000
|
-
* <p>An array of the IdPs in your user pool. For each, the response includes identifiers,
|
|
1001
|
-
* the IdP name and type, and trust-relationship details like the issuer URL.</p>
|
|
1002
|
-
* @public
|
|
1003
|
-
*/
|
|
1004
|
-
Providers: ProviderDescription[] | undefined;
|
|
1005
|
-
/**
|
|
1006
|
-
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1007
|
-
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1008
|
-
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1009
|
-
* @public
|
|
1010
|
-
*/
|
|
1011
|
-
NextToken?: string | undefined;
|
|
1012
|
-
}
|
|
1013
|
-
/**
|
|
1014
|
-
* @public
|
|
1015
|
-
*/
|
|
1016
|
-
export interface ListResourceServersRequest {
|
|
1017
|
-
/**
|
|
1018
|
-
* <p>The ID of the user pool where you want to list resource servers.</p>
|
|
1019
|
-
* @public
|
|
1020
|
-
*/
|
|
1021
|
-
UserPoolId: string | undefined;
|
|
1022
|
-
/**
|
|
1023
|
-
* <p>The maximum number of resource servers that you want Amazon Cognito to return in the
|
|
1024
|
-
* response.</p>
|
|
1025
|
-
* @public
|
|
1026
|
-
*/
|
|
1027
|
-
MaxResults?: number | undefined;
|
|
1028
|
-
/**
|
|
1029
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1030
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1031
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1032
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1033
|
-
* through the full list of items.</p>
|
|
1034
|
-
* @public
|
|
1035
|
-
*/
|
|
1036
|
-
NextToken?: string | undefined;
|
|
1037
|
-
}
|
|
1038
|
-
/**
|
|
1039
|
-
* @public
|
|
1040
|
-
*/
|
|
1041
|
-
export interface ListResourceServersResponse {
|
|
1042
|
-
/**
|
|
1043
|
-
* <p>An array of resource servers and the details of their configuration. For each, the
|
|
1044
|
-
* response includes names, identifiers, and custom scopes.</p>
|
|
1045
|
-
* @public
|
|
1046
|
-
*/
|
|
1047
|
-
ResourceServers: ResourceServerType[] | undefined;
|
|
1048
|
-
/**
|
|
1049
|
-
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1050
|
-
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1051
|
-
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1052
|
-
* @public
|
|
1053
|
-
*/
|
|
1054
|
-
NextToken?: string | undefined;
|
|
1055
|
-
}
|
|
1056
|
-
/**
|
|
1057
|
-
* @public
|
|
1058
|
-
*/
|
|
1059
|
-
export interface ListTagsForResourceRequest {
|
|
1060
|
-
/**
|
|
1061
|
-
* <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
|
|
1062
|
-
* @public
|
|
1063
|
-
*/
|
|
1064
|
-
ResourceArn: string | undefined;
|
|
1065
|
-
}
|
|
1066
|
-
/**
|
|
1067
|
-
* @public
|
|
1068
|
-
*/
|
|
1069
|
-
export interface ListTagsForResourceResponse {
|
|
1070
|
-
/**
|
|
1071
|
-
* <p>The tags that are assigned to the user pool.</p>
|
|
1072
|
-
* @public
|
|
1073
|
-
*/
|
|
1074
|
-
Tags?: Record<string, string> | undefined;
|
|
1075
|
-
}
|
|
1076
|
-
/**
|
|
1077
|
-
* @public
|
|
1078
|
-
*/
|
|
1079
|
-
export interface ListTermsRequest {
|
|
1080
|
-
/**
|
|
1081
|
-
* <p>The ID of the user pool where you want to list terms documents.</p>
|
|
1082
|
-
* @public
|
|
1083
|
-
*/
|
|
1084
|
-
UserPoolId: string | undefined;
|
|
1085
|
-
/**
|
|
1086
|
-
* <p>The maximum number of terms documents that you want Amazon Cognito to return in the
|
|
1087
|
-
* response.</p>
|
|
1088
|
-
* @public
|
|
1089
|
-
*/
|
|
1090
|
-
MaxResults?: number | undefined;
|
|
1091
|
-
/**
|
|
1092
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1093
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1094
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1095
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1096
|
-
* through the full list of items.</p>
|
|
1097
|
-
* @public
|
|
1098
|
-
*/
|
|
1099
|
-
NextToken?: string | undefined;
|
|
1100
|
-
}
|
|
1101
|
-
/**
|
|
1102
|
-
* <p>The details of a set of terms documents. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents">Terms documents</a>.</p>
|
|
1103
|
-
* @public
|
|
1104
|
-
*/
|
|
1105
|
-
export interface TermsDescriptionType {
|
|
1106
|
-
/**
|
|
1107
|
-
* <p>The ID of the requested terms documents.</p>
|
|
1108
|
-
* @public
|
|
1109
|
-
*/
|
|
1110
|
-
TermsId: string | undefined;
|
|
1111
|
-
/**
|
|
1112
|
-
* <p>The type and friendly name of the requested terms documents.</p>
|
|
1113
|
-
* @public
|
|
1114
|
-
*/
|
|
1115
|
-
TermsName: string | undefined;
|
|
1116
|
-
/**
|
|
1117
|
-
* <p>This parameter is reserved for future use and currently accepts one value.</p>
|
|
1118
|
-
* @public
|
|
1119
|
-
*/
|
|
1120
|
-
Enforcement: TermsEnforcementType | undefined;
|
|
1121
|
-
/**
|
|
1122
|
-
* <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
1123
|
-
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
1124
|
-
* @public
|
|
1125
|
-
*/
|
|
1126
|
-
CreationDate: Date | undefined;
|
|
1127
|
-
/**
|
|
1128
|
-
* <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
1129
|
-
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
1130
|
-
* @public
|
|
1131
|
-
*/
|
|
1132
|
-
LastModifiedDate: Date | undefined;
|
|
1133
|
-
}
|
|
1134
|
-
/**
|
|
1135
|
-
* @public
|
|
1136
|
-
*/
|
|
1137
|
-
export interface ListTermsResponse {
|
|
1138
|
-
/**
|
|
1139
|
-
* <p>A summary of the requested terms documents. Includes unique identifiers for later
|
|
1140
|
-
* changes to the terms documents.</p>
|
|
1141
|
-
* @public
|
|
1142
|
-
*/
|
|
1143
|
-
Terms: TermsDescriptionType[] | undefined;
|
|
1144
|
-
/**
|
|
1145
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1146
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1147
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1148
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1149
|
-
* through the full list of items.</p>
|
|
1150
|
-
* @public
|
|
1151
|
-
*/
|
|
1152
|
-
NextToken?: string | undefined;
|
|
1153
|
-
}
|
|
1154
|
-
/**
|
|
1155
|
-
* <p>Represents the request to list the user import jobs.</p>
|
|
1156
|
-
* @public
|
|
1157
|
-
*/
|
|
1158
|
-
export interface ListUserImportJobsRequest {
|
|
1159
|
-
/**
|
|
1160
|
-
* <p>The ID of the user pool where you want to list import jobs.</p>
|
|
1161
|
-
* @public
|
|
1162
|
-
*/
|
|
1163
|
-
UserPoolId: string | undefined;
|
|
1164
|
-
/**
|
|
1165
|
-
* <p>The maximum number of import jobs that you want Amazon Cognito to return in the
|
|
1166
|
-
* response.</p>
|
|
1167
|
-
* @public
|
|
1168
|
-
*/
|
|
1169
|
-
MaxResults: number | undefined;
|
|
1170
|
-
/**
|
|
1171
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1172
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1173
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1174
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1175
|
-
* through the full list of items.</p>
|
|
1176
|
-
* @public
|
|
1177
|
-
*/
|
|
1178
|
-
PaginationToken?: string | undefined;
|
|
1179
|
-
}
|
|
1180
|
-
/**
|
|
1181
|
-
* <p>Represents the response from the server to the request to list the user import
|
|
1182
|
-
* jobs.</p>
|
|
1183
|
-
* @public
|
|
1184
|
-
*/
|
|
1185
|
-
export interface ListUserImportJobsResponse {
|
|
1186
|
-
/**
|
|
1187
|
-
* <p>An array of user import jobs from the requested user pool. For each, the response
|
|
1188
|
-
* includes logging destination, status, and the Amazon S3 pre-signed URL for CSV upload.</p>
|
|
1189
|
-
* @public
|
|
1190
|
-
*/
|
|
1191
|
-
UserImportJobs?: UserImportJobType[] | undefined;
|
|
1192
|
-
/**
|
|
1193
|
-
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1194
|
-
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1195
|
-
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1196
|
-
* @public
|
|
1197
|
-
*/
|
|
1198
|
-
PaginationToken?: string | undefined;
|
|
1199
|
-
}
|
|
1200
|
-
/**
|
|
1201
|
-
* <p>Represents the request to list the user pool clients.</p>
|
|
1202
|
-
* @public
|
|
1203
|
-
*/
|
|
1204
|
-
export interface ListUserPoolClientsRequest {
|
|
1205
|
-
/**
|
|
1206
|
-
* <p>The ID of the user pool where you want to list user pool clients.</p>
|
|
1207
|
-
* @public
|
|
1208
|
-
*/
|
|
1209
|
-
UserPoolId: string | undefined;
|
|
1210
|
-
/**
|
|
1211
|
-
* <p>The maximum number of app clients that you want Amazon Cognito to return in the
|
|
1212
|
-
* response.</p>
|
|
1213
|
-
* @public
|
|
1214
|
-
*/
|
|
1215
|
-
MaxResults?: number | undefined;
|
|
1216
|
-
/**
|
|
1217
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1218
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1219
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1220
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1221
|
-
* through the full list of items.</p>
|
|
1222
|
-
* @public
|
|
1223
|
-
*/
|
|
1224
|
-
NextToken?: string | undefined;
|
|
1225
|
-
}
|
|
1226
|
-
/**
|
|
1227
|
-
* <p>A short description of a user pool app client.</p>
|
|
1228
|
-
* @public
|
|
1229
|
-
*/
|
|
1230
|
-
export interface UserPoolClientDescription {
|
|
1231
|
-
/**
|
|
1232
|
-
* <p>The app client ID.</p>
|
|
1233
|
-
* @public
|
|
1234
|
-
*/
|
|
1235
|
-
ClientId?: string | undefined;
|
|
1236
|
-
/**
|
|
1237
|
-
* <p>The ID of the user pool that's associated with the app client.</p>
|
|
1238
|
-
* @public
|
|
1239
|
-
*/
|
|
1240
|
-
UserPoolId?: string | undefined;
|
|
1241
|
-
/**
|
|
1242
|
-
* <p>The app client name.</p>
|
|
1243
|
-
* @public
|
|
1244
|
-
*/
|
|
1245
|
-
ClientName?: string | undefined;
|
|
1246
|
-
}
|
|
1247
|
-
/**
|
|
1248
|
-
* <p>Represents the response from the server that lists user pool clients.</p>
|
|
1249
|
-
* @public
|
|
1250
|
-
*/
|
|
1251
|
-
export interface ListUserPoolClientsResponse {
|
|
1252
|
-
/**
|
|
1253
|
-
* <p>An array of app clients and their details. Includes app client ID and name.</p>
|
|
1254
|
-
* @public
|
|
1255
|
-
*/
|
|
1256
|
-
UserPoolClients?: UserPoolClientDescription[] | undefined;
|
|
1257
|
-
/**
|
|
1258
|
-
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1259
|
-
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1260
|
-
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1261
|
-
* @public
|
|
1262
|
-
*/
|
|
1263
|
-
NextToken?: string | undefined;
|
|
1264
|
-
}
|
|
1265
|
-
/**
|
|
1266
|
-
* <p>Represents the request to list user pools.</p>
|
|
1267
|
-
* @public
|
|
1268
|
-
*/
|
|
1269
|
-
export interface ListUserPoolsRequest {
|
|
1270
|
-
/**
|
|
1271
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1272
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1273
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1274
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1275
|
-
* through the full list of items.</p>
|
|
1276
|
-
* @public
|
|
1277
|
-
*/
|
|
1278
|
-
NextToken?: string | undefined;
|
|
1279
|
-
/**
|
|
1280
|
-
* <p>The maximum number of user pools that you want Amazon Cognito to return in the response.</p>
|
|
1281
|
-
* @public
|
|
1282
|
-
*/
|
|
1283
|
-
MaxResults: number | undefined;
|
|
1284
|
-
}
|
|
1285
|
-
/**
|
|
1286
|
-
* <p>A short description of a user pool.</p>
|
|
1287
|
-
* @public
|
|
1288
|
-
*/
|
|
1289
|
-
export interface UserPoolDescriptionType {
|
|
1290
|
-
/**
|
|
1291
|
-
* <p>The user pool ID.</p>
|
|
1292
|
-
* @public
|
|
1293
|
-
*/
|
|
1294
|
-
Id?: string | undefined;
|
|
1295
|
-
/**
|
|
1296
|
-
* <p>The user pool name.</p>
|
|
1297
|
-
* @public
|
|
1298
|
-
*/
|
|
1299
|
-
Name?: string | undefined;
|
|
1300
|
-
/**
|
|
1301
|
-
* <p>A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible
|
|
1302
|
-
* stages of user pool operations. Triggers can modify the outcome of the operations that
|
|
1303
|
-
* invoked them.</p>
|
|
1304
|
-
* @public
|
|
1305
|
-
*/
|
|
1306
|
-
LambdaConfig?: LambdaConfigType | undefined;
|
|
1307
|
-
/**
|
|
1308
|
-
* <p>The user pool status.</p>
|
|
1309
|
-
*
|
|
1310
|
-
* @deprecated This property is no longer available.
|
|
1311
|
-
* @public
|
|
1312
|
-
*/
|
|
1313
|
-
Status?: StatusType | undefined;
|
|
1314
|
-
/**
|
|
1315
|
-
* <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
1316
|
-
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
1317
|
-
* @public
|
|
1318
|
-
*/
|
|
1319
|
-
LastModifiedDate?: Date | undefined;
|
|
1320
|
-
/**
|
|
1321
|
-
* <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
1322
|
-
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
1323
|
-
* @public
|
|
1324
|
-
*/
|
|
1325
|
-
CreationDate?: Date | undefined;
|
|
1326
|
-
}
|
|
1327
|
-
/**
|
|
1328
|
-
* <p>Represents the response to list user pools.</p>
|
|
1329
|
-
* @public
|
|
1330
|
-
*/
|
|
1331
|
-
export interface ListUserPoolsResponse {
|
|
1332
|
-
/**
|
|
1333
|
-
* <p>An array of user pools and their configuration details.</p>
|
|
1334
|
-
* @public
|
|
1335
|
-
*/
|
|
1336
|
-
UserPools?: UserPoolDescriptionType[] | undefined;
|
|
1337
|
-
/**
|
|
1338
|
-
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1339
|
-
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1340
|
-
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1341
|
-
* @public
|
|
1342
|
-
*/
|
|
1343
|
-
NextToken?: string | undefined;
|
|
1344
|
-
}
|
|
1345
|
-
/**
|
|
1346
|
-
* <p>Represents the request to list users.</p>
|
|
1347
|
-
* @public
|
|
1348
|
-
*/
|
|
1349
|
-
export interface ListUsersRequest {
|
|
1350
|
-
/**
|
|
1351
|
-
* <p>The ID of the user pool where you want to display or search for users.</p>
|
|
1352
|
-
* @public
|
|
1353
|
-
*/
|
|
1354
|
-
UserPoolId: string | undefined;
|
|
1355
|
-
/**
|
|
1356
|
-
* <p>A JSON array of user attribute names, for example <code>given_name</code>, that you
|
|
1357
|
-
* want Amazon Cognito to include in the response for each user. When you don't provide an
|
|
1358
|
-
* <code>AttributesToGet</code> parameter, Amazon Cognito returns all attributes for each
|
|
1359
|
-
* user.</p>
|
|
1360
|
-
* <p>Use <code>AttributesToGet</code> with required attributes in your user pool, or in
|
|
1361
|
-
* conjunction with <code>Filter</code>. Amazon Cognito returns an error if not all users in the
|
|
1362
|
-
* results have set a value for the attribute you request. Attributes that you can't
|
|
1363
|
-
* filter on, including custom attributes, must have a value set in every user profile
|
|
1364
|
-
* before an <code>AttributesToGet</code> parameter returns results.</p>
|
|
1365
|
-
* @public
|
|
1366
|
-
*/
|
|
1367
|
-
AttributesToGet?: string[] | undefined;
|
|
1368
|
-
/**
|
|
1369
|
-
* <p>The maximum number of users that you want Amazon Cognito to return in the response.</p>
|
|
1370
|
-
* @public
|
|
1371
|
-
*/
|
|
1372
|
-
Limit?: number | undefined;
|
|
1373
|
-
/**
|
|
1374
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1375
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1376
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1377
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1378
|
-
* through the full list of items.</p>
|
|
1379
|
-
* @public
|
|
1380
|
-
*/
|
|
1381
|
-
PaginationToken?: string | undefined;
|
|
1382
|
-
/**
|
|
1383
|
-
* <p>A filter string of the form <code>"AttributeName Filter-Type "AttributeValue"</code>.
|
|
1384
|
-
* Quotation marks within the filter string must be escaped using the backslash
|
|
1385
|
-
* (<code>\</code>) character. For example, <code>"family_name =
|
|
1386
|
-
* \"Reddy\""</code>.</p>
|
|
1387
|
-
* <ul>
|
|
1388
|
-
* <li>
|
|
1389
|
-
* <p>
|
|
1390
|
-
* <i>AttributeName</i>: The name of the attribute to search for.
|
|
1391
|
-
* You can only search for one attribute at a time.</p>
|
|
1392
|
-
* </li>
|
|
1393
|
-
* <li>
|
|
1394
|
-
* <p>
|
|
1395
|
-
* <i>Filter-Type</i>: For an exact match, use <code>=</code>, for
|
|
1396
|
-
* example, "<code>given_name = \"Jon\"</code>". For a prefix ("starts with")
|
|
1397
|
-
* match, use <code>^=</code>, for example, "<code>given_name ^= \"Jon\"</code>".
|
|
1398
|
-
* </p>
|
|
1399
|
-
* </li>
|
|
1400
|
-
* <li>
|
|
1401
|
-
* <p>
|
|
1402
|
-
* <i>AttributeValue</i>: The attribute value that must be matched
|
|
1403
|
-
* for each user.</p>
|
|
1404
|
-
* </li>
|
|
1405
|
-
* </ul>
|
|
1406
|
-
* <p>If the filter string is empty, <code>ListUsers</code> returns all users in the user
|
|
1407
|
-
* pool.</p>
|
|
1408
|
-
* <p>You can only search for the following standard attributes:</p>
|
|
1409
|
-
* <ul>
|
|
1410
|
-
* <li>
|
|
1411
|
-
* <p>
|
|
1412
|
-
* <code>username</code> (case-sensitive)</p>
|
|
1413
|
-
* </li>
|
|
1414
|
-
* <li>
|
|
1415
|
-
* <p>
|
|
1416
|
-
* <code>email</code>
|
|
1417
|
-
* </p>
|
|
1418
|
-
* </li>
|
|
1419
|
-
* <li>
|
|
1420
|
-
* <p>
|
|
1421
|
-
* <code>phone_number</code>
|
|
1422
|
-
* </p>
|
|
1423
|
-
* </li>
|
|
1424
|
-
* <li>
|
|
1425
|
-
* <p>
|
|
1426
|
-
* <code>name</code>
|
|
1427
|
-
* </p>
|
|
1428
|
-
* </li>
|
|
1429
|
-
* <li>
|
|
1430
|
-
* <p>
|
|
1431
|
-
* <code>given_name</code>
|
|
1432
|
-
* </p>
|
|
1433
|
-
* </li>
|
|
1434
|
-
* <li>
|
|
1435
|
-
* <p>
|
|
1436
|
-
* <code>family_name</code>
|
|
1437
|
-
* </p>
|
|
1438
|
-
* </li>
|
|
1439
|
-
* <li>
|
|
1440
|
-
* <p>
|
|
1441
|
-
* <code>preferred_username</code>
|
|
1442
|
-
* </p>
|
|
1443
|
-
* </li>
|
|
1444
|
-
* <li>
|
|
1445
|
-
* <p>
|
|
1446
|
-
* <code>cognito:user_status</code> (called <b>Status</b> in the Console) (case-insensitive)</p>
|
|
1447
|
-
* </li>
|
|
1448
|
-
* <li>
|
|
1449
|
-
* <p>
|
|
1450
|
-
* <code>status (called <b>Enabled</b> in the Console)
|
|
1451
|
-
* (case-sensitive)</code>
|
|
1452
|
-
* </p>
|
|
1453
|
-
* </li>
|
|
1454
|
-
* <li>
|
|
1455
|
-
* <p>
|
|
1456
|
-
* <code>sub</code>
|
|
1457
|
-
* </p>
|
|
1458
|
-
* </li>
|
|
1459
|
-
* </ul>
|
|
1460
|
-
* <p>Custom attributes aren't searchable.</p>
|
|
1461
|
-
* <note>
|
|
1462
|
-
* <p>You can also list users with a client-side filter. The server-side filter matches
|
|
1463
|
-
* no more than one attribute. For an advanced search, use a client-side filter with
|
|
1464
|
-
* the <code>--query</code> parameter of the <code>list-users</code> action in the
|
|
1465
|
-
* CLI. When you use a client-side filter, ListUsers returns a paginated list of zero
|
|
1466
|
-
* or more users. You can receive multiple pages in a row with zero results. Repeat the
|
|
1467
|
-
* query with each pagination token that is returned until you receive a null
|
|
1468
|
-
* pagination token value, and then review the combined result. </p>
|
|
1469
|
-
* <p>For more information about server-side and client-side filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">FilteringCLI output</a> in the <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Command Line Interface
|
|
1470
|
-
* User Guide</a>. </p>
|
|
1471
|
-
* </note>
|
|
1472
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api">Searching for Users Using the ListUsers API</a> and <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples">Examples of Using the ListUsers API</a> in the <i>Amazon Cognito Developer
|
|
1473
|
-
* Guide</i>.</p>
|
|
1474
|
-
* @public
|
|
1475
|
-
*/
|
|
1476
|
-
Filter?: string | undefined;
|
|
1477
|
-
}
|
|
1478
|
-
/**
|
|
1479
|
-
* <p>The response from the request to list users.</p>
|
|
1480
|
-
* @public
|
|
1481
|
-
*/
|
|
1482
|
-
export interface ListUsersResponse {
|
|
1483
|
-
/**
|
|
1484
|
-
* <p>An array of user pool users who match your query, and their attributes.</p>
|
|
1485
|
-
* @public
|
|
1486
|
-
*/
|
|
1487
|
-
Users?: UserType[] | undefined;
|
|
1488
|
-
/**
|
|
1489
|
-
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1490
|
-
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1491
|
-
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1492
|
-
* @public
|
|
1493
|
-
*/
|
|
1494
|
-
PaginationToken?: string | undefined;
|
|
1495
|
-
}
|
|
1496
|
-
/**
|
|
1497
|
-
* @public
|
|
1498
|
-
*/
|
|
1499
|
-
export interface ListUsersInGroupRequest {
|
|
1500
|
-
/**
|
|
1501
|
-
* <p>The ID of the user pool where you want to view the membership of the requested
|
|
1502
|
-
* group.</p>
|
|
1503
|
-
* @public
|
|
1504
|
-
*/
|
|
1505
|
-
UserPoolId: string | undefined;
|
|
1506
|
-
/**
|
|
1507
|
-
* <p>The name of the group that you want to query for user membership.</p>
|
|
1508
|
-
* @public
|
|
1509
|
-
*/
|
|
1510
|
-
GroupName: string | undefined;
|
|
1511
|
-
/**
|
|
1512
|
-
* <p>The maximum number of groups that you want Amazon Cognito to return in the response.</p>
|
|
1513
|
-
* @public
|
|
1514
|
-
*/
|
|
1515
|
-
Limit?: number | undefined;
|
|
1516
|
-
/**
|
|
1517
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1518
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1519
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1520
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1521
|
-
* through the full list of items.</p>
|
|
1522
|
-
* @public
|
|
1523
|
-
*/
|
|
1524
|
-
NextToken?: string | undefined;
|
|
1525
|
-
}
|
|
1526
|
-
/**
|
|
1527
|
-
* @public
|
|
1528
|
-
*/
|
|
1529
|
-
export interface ListUsersInGroupResponse {
|
|
1530
|
-
/**
|
|
1531
|
-
* <p>An array of users who are members in the group, and their attributes.</p>
|
|
1532
|
-
* @public
|
|
1533
|
-
*/
|
|
1534
|
-
Users?: UserType[] | undefined;
|
|
1535
|
-
/**
|
|
1536
|
-
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1537
|
-
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1538
|
-
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1539
|
-
* @public
|
|
1540
|
-
*/
|
|
1541
|
-
NextToken?: string | undefined;
|
|
1542
|
-
}
|
|
1543
|
-
/**
|
|
1544
|
-
* @public
|
|
1545
|
-
*/
|
|
1546
|
-
export interface ListWebAuthnCredentialsRequest {
|
|
1547
|
-
/**
|
|
1548
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
1549
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
1550
|
-
* @public
|
|
1551
|
-
*/
|
|
1552
|
-
AccessToken: string | undefined;
|
|
1553
|
-
/**
|
|
1554
|
-
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1555
|
-
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1556
|
-
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1557
|
-
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1558
|
-
* through the full list of items.</p>
|
|
1559
|
-
* @public
|
|
1560
|
-
*/
|
|
1561
|
-
NextToken?: string | undefined;
|
|
1562
|
-
/**
|
|
1563
|
-
* <p>The maximum number of the user's passkey credentials that you want to
|
|
1564
|
-
* return.</p>
|
|
1565
|
-
* @public
|
|
1566
|
-
*/
|
|
1567
|
-
MaxResults?: number | undefined;
|
|
1568
|
-
}
|
|
1569
|
-
/**
|
|
1570
|
-
* <p>The details of a passkey, or webauthN, biometric or security-key authentication factor
|
|
1571
|
-
* for a user.</p>
|
|
1572
|
-
* @public
|
|
1573
|
-
*/
|
|
1574
|
-
export interface WebAuthnCredentialDescription {
|
|
1575
|
-
/**
|
|
1576
|
-
* <p>The unique identifier of the passkey credential.</p>
|
|
1577
|
-
* @public
|
|
1578
|
-
*/
|
|
1579
|
-
CredentialId: string | undefined;
|
|
1580
|
-
/**
|
|
1581
|
-
* <p>An automatically-generated friendly name for the passkey credential.</p>
|
|
1582
|
-
* @public
|
|
1583
|
-
*/
|
|
1584
|
-
FriendlyCredentialName: string | undefined;
|
|
1585
|
-
/**
|
|
1586
|
-
* <p>The relying-party ID of the provider for the passkey credential.</p>
|
|
1587
|
-
* @public
|
|
1588
|
-
*/
|
|
1589
|
-
RelyingPartyId: string | undefined;
|
|
1590
|
-
/**
|
|
1591
|
-
* <p>The general category of the passkey authenticator. Can be a platform, or on-device
|
|
1592
|
-
* authenticator like a built-in fingerprint scanner, or a cross-platform device that's not
|
|
1593
|
-
* attached to the device like a Bluetooth security key.</p>
|
|
1594
|
-
* @public
|
|
1595
|
-
*/
|
|
1596
|
-
AuthenticatorAttachment?: string | undefined;
|
|
1597
|
-
/**
|
|
1598
|
-
* <p>Information about the transport methods of the passkey credential, for example USB or
|
|
1599
|
-
* Bluetooth Low Energy.</p>
|
|
1600
|
-
* @public
|
|
1601
|
-
*/
|
|
1602
|
-
AuthenticatorTransports: string[] | undefined;
|
|
1603
|
-
/**
|
|
1604
|
-
* <p>The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
1605
|
-
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
1606
|
-
* @public
|
|
1607
|
-
*/
|
|
1608
|
-
CreatedAt: Date | undefined;
|
|
1609
|
-
}
|
|
1610
|
-
/**
|
|
1611
|
-
* @public
|
|
1612
|
-
*/
|
|
1613
|
-
export interface ListWebAuthnCredentialsResponse {
|
|
1614
|
-
/**
|
|
1615
|
-
* <p>A list of registered passkeys for a user.</p>
|
|
1616
|
-
* @public
|
|
1617
|
-
*/
|
|
1618
|
-
Credentials: WebAuthnCredentialDescription[] | undefined;
|
|
1619
|
-
/**
|
|
1620
|
-
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1621
|
-
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1622
|
-
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1623
|
-
* @public
|
|
1624
|
-
*/
|
|
1625
|
-
NextToken?: string | undefined;
|
|
1626
|
-
}
|
|
1627
|
-
/**
|
|
1628
|
-
* <p>Represents the request to resend the confirmation code.</p>
|
|
1629
|
-
* @public
|
|
1630
|
-
*/
|
|
1631
|
-
export interface ResendConfirmationCodeRequest {
|
|
1632
|
-
/**
|
|
1633
|
-
* <p>The ID of the user pool app client where the user signed up.</p>
|
|
1634
|
-
* @public
|
|
1635
|
-
*/
|
|
1636
|
-
ClientId: string | undefined;
|
|
1637
|
-
/**
|
|
1638
|
-
* <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
|
|
1639
|
-
* user pool client and username plus the client ID in the message. For more information
|
|
1640
|
-
* about <code>SecretHash</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>.</p>
|
|
1641
|
-
* @public
|
|
1642
|
-
*/
|
|
1643
|
-
SecretHash?: string | undefined;
|
|
1644
|
-
/**
|
|
1645
|
-
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
1646
|
-
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
1647
|
-
* when it makes API requests.</p>
|
|
1648
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
1649
|
-
* applications</a>.</p>
|
|
1650
|
-
* @public
|
|
1651
|
-
*/
|
|
1652
|
-
UserContextData?: UserContextDataType | undefined;
|
|
1653
|
-
/**
|
|
1654
|
-
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
1655
|
-
* is typically your user's username, but it can be any of their alias attributes. If
|
|
1656
|
-
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
1657
|
-
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
1658
|
-
* third-party IdP.</p>
|
|
1659
|
-
* @public
|
|
1660
|
-
*/
|
|
1661
|
-
Username: string | undefined;
|
|
1662
|
-
/**
|
|
1663
|
-
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
1664
|
-
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
1665
|
-
* email address, or phone number.</p>
|
|
1666
|
-
* @public
|
|
1667
|
-
*/
|
|
1668
|
-
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
1669
|
-
/**
|
|
1670
|
-
* <p>A map of custom key-value pairs that you can provide as input for any custom workflows
|
|
1671
|
-
* that this action triggers.</p>
|
|
1672
|
-
* <p>You create custom workflows by assigning Lambda functions to user pool triggers.
|
|
1673
|
-
* When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is
|
|
1674
|
-
* assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this
|
|
1675
|
-
* function, it passes a JSON payload, which the function receives as input. This payload
|
|
1676
|
-
* contains a <code>clientMetadata</code> attribute, which provides the data that you
|
|
1677
|
-
* assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your
|
|
1678
|
-
* function code in Lambda, you can process the <code>clientMetadata</code> value to enhance
|
|
1679
|
-
* your workflow for your specific needs.</p>
|
|
1680
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
1681
|
-
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
1682
|
-
* <note>
|
|
1683
|
-
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
1684
|
-
* following:</p>
|
|
1685
|
-
* <ul>
|
|
1686
|
-
* <li>
|
|
1687
|
-
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
1688
|
-
* to Lambda triggers that are assigned to a user pool to support custom
|
|
1689
|
-
* workflows. If your user pool configuration doesn't include triggers, the
|
|
1690
|
-
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
1691
|
-
* </li>
|
|
1692
|
-
* <li>
|
|
1693
|
-
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
1694
|
-
* </li>
|
|
1695
|
-
* <li>
|
|
1696
|
-
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
1697
|
-
* information in this parameter.</p>
|
|
1698
|
-
* </li>
|
|
1699
|
-
* </ul>
|
|
1700
|
-
* </note>
|
|
1701
|
-
* @public
|
|
1702
|
-
*/
|
|
1703
|
-
ClientMetadata?: Record<string, string> | undefined;
|
|
1704
|
-
}
|
|
1705
|
-
/**
|
|
1706
|
-
* <p>The response from the server when Amazon Cognito makes the request to resend a confirmation
|
|
1707
|
-
* code.</p>
|
|
1708
|
-
* @public
|
|
1709
|
-
*/
|
|
1710
|
-
export interface ResendConfirmationCodeResponse {
|
|
1711
|
-
/**
|
|
1712
|
-
* <p>Information about the phone number or email address that Amazon Cognito sent the confirmation
|
|
1713
|
-
* code to.</p>
|
|
1714
|
-
* @public
|
|
1715
|
-
*/
|
|
1716
|
-
CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
|
|
1717
|
-
}
|
|
1718
|
-
/**
|
|
1719
|
-
* <p>The request to respond to an authentication challenge.</p>
|
|
1720
|
-
* @public
|
|
1721
|
-
*/
|
|
1722
|
-
export interface RespondToAuthChallengeRequest {
|
|
1723
|
-
/**
|
|
1724
|
-
* <p>The ID of the app client where the user is signing in.</p>
|
|
1725
|
-
* @public
|
|
1726
|
-
*/
|
|
1727
|
-
ClientId: string | undefined;
|
|
1728
|
-
/**
|
|
1729
|
-
* <p>The name of the challenge that you are responding to.</p>
|
|
1730
|
-
* <note>
|
|
1731
|
-
* <p>You can't respond to an <code>ADMIN_NO_SRP_AUTH</code> challenge with this
|
|
1732
|
-
* operation.</p>
|
|
1733
|
-
* </note>
|
|
1734
|
-
* <p>Possible challenges include the following:</p>
|
|
1735
|
-
* <note>
|
|
1736
|
-
* <p>All of the following challenges require <code>USERNAME</code> and, when the app
|
|
1737
|
-
* client has a client secret, <code>SECRET_HASH</code> in the parameters. Include a
|
|
1738
|
-
* <code>DEVICE_KEY</code> for device authentication.</p>
|
|
1739
|
-
* </note>
|
|
1740
|
-
* <ul>
|
|
1741
|
-
* <li>
|
|
1742
|
-
* <p>
|
|
1743
|
-
* <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
|
|
1744
|
-
* successful authentication with a WebAuthn authenticator, or passkey, as
|
|
1745
|
-
* <code>CREDENTIAL</code>. Examples of WebAuthn authenticators include
|
|
1746
|
-
* biometric devices and security keys.</p>
|
|
1747
|
-
* </li>
|
|
1748
|
-
* <li>
|
|
1749
|
-
* <p>
|
|
1750
|
-
* <code>PASSWORD</code>: Respond with the user's password as <code>PASSWORD</code>.</p>
|
|
1751
|
-
* </li>
|
|
1752
|
-
* <li>
|
|
1753
|
-
* <p>
|
|
1754
|
-
* <code>PASSWORD_SRP</code>: Respond with the initial SRP secret as <code>SRP_A</code>.</p>
|
|
1755
|
-
* </li>
|
|
1756
|
-
* <li>
|
|
1757
|
-
* <p>
|
|
1758
|
-
* <code>SELECT_CHALLENGE</code>: Respond with a challenge selection as <code>ANSWER</code>.
|
|
1759
|
-
* It must be one of the challenge types in the <code>AvailableChallenges</code> response
|
|
1760
|
-
* parameter. Add the parameters of the selected challenge, for example <code>USERNAME</code>
|
|
1761
|
-
* and <code>SMS_OTP</code>.</p>
|
|
1762
|
-
* </li>
|
|
1763
|
-
* <li>
|
|
1764
|
-
* <p>
|
|
1765
|
-
* <code>SMS_MFA</code>: Respond with the code that your user pool delivered in an SMS
|
|
1766
|
-
* message, as <code>SMS_MFA_CODE</code>
|
|
1767
|
-
* </p>
|
|
1768
|
-
* </li>
|
|
1769
|
-
* <li>
|
|
1770
|
-
* <p>
|
|
1771
|
-
* <code>EMAIL_MFA</code>: Respond with the code that your user pool delivered in an email
|
|
1772
|
-
* message, as <code>EMAIL_MFA_CODE</code>
|
|
1773
|
-
* </p>
|
|
1774
|
-
* </li>
|
|
1775
|
-
* <li>
|
|
1776
|
-
* <p>
|
|
1777
|
-
* <code>EMAIL_OTP</code>: Respond with the code that your user pool delivered in an email
|
|
1778
|
-
* message, as <code>EMAIL_OTP_CODE</code> .</p>
|
|
1779
|
-
* </li>
|
|
1780
|
-
* <li>
|
|
1781
|
-
* <p>
|
|
1782
|
-
* <code>SMS_OTP</code>: Respond with the code that your user pool delivered in an SMS
|
|
1783
|
-
* message, as <code>SMS_OTP_CODE</code>.</p>
|
|
1784
|
-
* </li>
|
|
1785
|
-
* <li>
|
|
1786
|
-
* <p>
|
|
1787
|
-
* <code>PASSWORD_VERIFIER</code>: Respond with the second stage of SRP secrets as
|
|
1788
|
-
* <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>,
|
|
1789
|
-
* and <code>TIMESTAMP</code>.</p>
|
|
1790
|
-
* </li>
|
|
1791
|
-
* <li>
|
|
1792
|
-
* <p>
|
|
1793
|
-
* <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
|
|
1794
|
-
* flow determines that the user should pass another challenge before tokens are
|
|
1795
|
-
* issued. The parameters of the challenge are determined by your Lambda function
|
|
1796
|
-
* and issued in the <code>ChallengeParameters</code> of a challenge response.</p>
|
|
1797
|
-
* </li>
|
|
1798
|
-
* <li>
|
|
1799
|
-
* <p>
|
|
1800
|
-
* <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
|
|
1801
|
-
* authentication. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
1802
|
-
* </li>
|
|
1803
|
-
* <li>
|
|
1804
|
-
* <p>
|
|
1805
|
-
* <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
|
|
1806
|
-
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
1807
|
-
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
1808
|
-
* client-side SRP calculations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
1809
|
-
* </li>
|
|
1810
|
-
* <li>
|
|
1811
|
-
* <p>
|
|
1812
|
-
* <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
|
|
1813
|
-
* passwords after successful first login. Respond to this challenge with
|
|
1814
|
-
* <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
|
|
1815
|
-
* the <code>requiredAttributes</code> parameter. You can also set values for
|
|
1816
|
-
* attributes that aren't required by your user pool and that your app client
|
|
1817
|
-
* can write.</p>
|
|
1818
|
-
* <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
|
|
1819
|
-
* When you create passwordless users, you must provide values for all required
|
|
1820
|
-
* attributes.</p>
|
|
1821
|
-
* <note>
|
|
1822
|
-
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
1823
|
-
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
1824
|
-
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
1825
|
-
* operation to modify the value of any additional attributes.</p>
|
|
1826
|
-
* </note>
|
|
1827
|
-
* </li>
|
|
1828
|
-
* <li>
|
|
1829
|
-
* <p>
|
|
1830
|
-
* <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
|
|
1831
|
-
* before they can sign in. The MFA types activated for the user pool will be
|
|
1832
|
-
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
1833
|
-
* <p>To set up time-based one-time password (TOTP) MFA, use the session returned
|
|
1834
|
-
* in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
|
|
1835
|
-
* as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
|
|
1836
|
-
* by <code>VerifySoftwareToken</code> as an input to
|
|
1837
|
-
* <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
|
|
1838
|
-
* with challenge name <code>MFA_SETUP</code> to complete sign-in.
|
|
1839
|
-
* </p>
|
|
1840
|
-
* <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
|
|
1841
|
-
* <code>email</code> attribute for the user. Then restart the authentication
|
|
1842
|
-
* flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
|
|
1843
|
-
* </p>
|
|
1844
|
-
* </li>
|
|
1845
|
-
* </ul>
|
|
1846
|
-
* @public
|
|
1847
|
-
*/
|
|
1848
|
-
ChallengeName: ChallengeNameType | undefined;
|
|
1849
|
-
/**
|
|
1850
|
-
* <p>The session identifier that maintains the state of authentication requests and
|
|
1851
|
-
* challenge responses. If an <code>AdminInitiateAuth</code> or
|
|
1852
|
-
* <code>AdminRespondToAuthChallenge</code> API request results in a determination that
|
|
1853
|
-
* your application must pass another challenge, Amazon Cognito returns a session with other
|
|
1854
|
-
* challenge parameters. Send this session identifier, unmodified, to the next
|
|
1855
|
-
* <code>AdminRespondToAuthChallenge</code> request.</p>
|
|
1856
|
-
* @public
|
|
1857
|
-
*/
|
|
1858
|
-
Session?: string | undefined;
|
|
1859
|
-
/**
|
|
1860
|
-
* <p>The responses to the challenge that you received in the previous request. Each
|
|
1861
|
-
* challenge has its own required response parameters. The following examples are partial
|
|
1862
|
-
* JSON request bodies that highlight challenge-response parameters.</p>
|
|
1863
|
-
* <important>
|
|
1864
|
-
* <p>You must provide a SECRET_HASH parameter in all challenge responses to an app
|
|
1865
|
-
* client that has a client secret. Include a <code>DEVICE_KEY</code> for device
|
|
1866
|
-
* authentication.</p>
|
|
1867
|
-
* </important>
|
|
1868
|
-
* <dl>
|
|
1869
|
-
* <dt>SELECT_CHALLENGE</dt>
|
|
1870
|
-
* <dd>
|
|
1871
|
-
* <p>
|
|
1872
|
-
* <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
|
|
1873
|
-
* "USERNAME": "[username]",
|
|
1874
|
-
* "ANSWER": "[Challenge name]"\}</code>
|
|
1875
|
-
* </p>
|
|
1876
|
-
* <p>Available challenges are <code>PASSWORD</code>, <code>PASSWORD_SRP</code>,
|
|
1877
|
-
* <code>EMAIL_OTP</code>, <code>SMS_OTP</code>, and <code>WEB_AUTHN</code>.</p>
|
|
1878
|
-
* <p>Complete authentication in the <code>SELECT_CHALLENGE</code> response for
|
|
1879
|
-
* <code>PASSWORD</code>, <code>PASSWORD_SRP</code>, and <code>WEB_AUTHN</code>:</p>
|
|
1880
|
-
* <ul>
|
|
1881
|
-
* <li>
|
|
1882
|
-
* <p>
|
|
1883
|
-
* <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
|
|
1884
|
-
* "ANSWER": "WEB_AUTHN",
|
|
1885
|
-
* "USERNAME": "[username]",
|
|
1886
|
-
* "CREDENTIAL": "[AuthenticationResponseJSON]"\}</code>
|
|
1887
|
-
* </p>
|
|
1888
|
-
* <p>See <a href="https://www.w3.org/TR/WebAuthn-3/#dictdef-authenticationresponsejson">
|
|
1889
|
-
* AuthenticationResponseJSON</a>.</p>
|
|
1890
|
-
* </li>
|
|
1891
|
-
* <li>
|
|
1892
|
-
* <p>
|
|
1893
|
-
* <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
|
|
1894
|
-
* "ANSWER": "PASSWORD",
|
|
1895
|
-
* "USERNAME": "[username]",
|
|
1896
|
-
* "PASSWORD": "[password]"\}</code>
|
|
1897
|
-
* </p>
|
|
1898
|
-
* </li>
|
|
1899
|
-
* <li>
|
|
1900
|
-
* <p>
|
|
1901
|
-
* <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
|
|
1902
|
-
* "ANSWER": "PASSWORD_SRP",
|
|
1903
|
-
* "USERNAME": "[username]",
|
|
1904
|
-
* "SRP_A": "[SRP_A]"\}</code>
|
|
1905
|
-
* </p>
|
|
1906
|
-
* </li>
|
|
1907
|
-
* </ul>
|
|
1908
|
-
* <p>For <code>SMS_OTP</code> and <code>EMAIL_OTP</code>, respond with the
|
|
1909
|
-
* username and answer. Your user pool will send a code for the user to submit in
|
|
1910
|
-
* the next challenge response.</p>
|
|
1911
|
-
* <ul>
|
|
1912
|
-
* <li>
|
|
1913
|
-
* <p>
|
|
1914
|
-
* <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
|
|
1915
|
-
* "ANSWER": "SMS_OTP",
|
|
1916
|
-
* "USERNAME": "[username]"\}</code>
|
|
1917
|
-
* </p>
|
|
1918
|
-
* </li>
|
|
1919
|
-
* <li>
|
|
1920
|
-
* <p>
|
|
1921
|
-
* <code>"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
|
|
1922
|
-
* "ANSWER": "EMAIL_OTP",
|
|
1923
|
-
* "USERNAME": "[username]"\}</code>
|
|
1924
|
-
* </p>
|
|
1925
|
-
* </li>
|
|
1926
|
-
* </ul>
|
|
1927
|
-
* </dd>
|
|
1928
|
-
* <dt>WEB_AUTHN</dt>
|
|
1929
|
-
* <dd>
|
|
1930
|
-
* <p>
|
|
1931
|
-
* <code>"ChallengeName": "WEB_AUTHN", "ChallengeResponses": \{
|
|
1932
|
-
* "USERNAME": "[username]",
|
|
1933
|
-
* "CREDENTIAL": "[AuthenticationResponseJSON]"\}</code>
|
|
1934
|
-
* </p>
|
|
1935
|
-
* <p>See <a href="https://www.w3.org/TR/WebAuthn-3/#dictdef-authenticationresponsejson">
|
|
1936
|
-
* AuthenticationResponseJSON</a>.</p>
|
|
1937
|
-
* </dd>
|
|
1938
|
-
* <dt>PASSWORD</dt>
|
|
1939
|
-
* <dd>
|
|
1940
|
-
* <p>
|
|
1941
|
-
* <code>"ChallengeName": "PASSWORD", "ChallengeResponses": \{
|
|
1942
|
-
* "USERNAME": "[username]",
|
|
1943
|
-
* "PASSWORD": "[password]"\}</code>
|
|
1944
|
-
* </p>
|
|
1945
|
-
* </dd>
|
|
1946
|
-
* <dt>PASSWORD_SRP</dt>
|
|
1947
|
-
* <dd>
|
|
1948
|
-
* <p>
|
|
1949
|
-
* <code>"ChallengeName": "PASSWORD_SRP", "ChallengeResponses": \{
|
|
1950
|
-
* "USERNAME": "[username]",
|
|
1951
|
-
* "SRP_A": "[SRP_A]"\}</code>
|
|
1952
|
-
* </p>
|
|
1953
|
-
* </dd>
|
|
1954
|
-
* <dt>SMS_OTP</dt>
|
|
1955
|
-
* <dd>
|
|
1956
|
-
* <p>
|
|
1957
|
-
* <code>"ChallengeName": "SMS_OTP", "ChallengeResponses":
|
|
1958
|
-
* \{"SMS_OTP_CODE": "[code]", "USERNAME": "[username]"\}</code>
|
|
1959
|
-
* </p>
|
|
1960
|
-
* </dd>
|
|
1961
|
-
* <dt>EMAIL_OTP</dt>
|
|
1962
|
-
* <dd>
|
|
1963
|
-
* <p>
|
|
1964
|
-
* <code>"ChallengeName": "EMAIL_OTP", "ChallengeResponses": \{"EMAIL_OTP_CODE":
|
|
1965
|
-
* "[code]", "USERNAME": "[username]"\}</code>
|
|
1966
|
-
* </p>
|
|
1967
|
-
* </dd>
|
|
1968
|
-
* <dt>SMS_MFA</dt>
|
|
1969
|
-
* <dd>
|
|
1970
|
-
* <p>
|
|
1971
|
-
* <code>"ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
|
|
1972
|
-
* "[code]", "USERNAME": "[username]"\}</code>
|
|
1973
|
-
* </p>
|
|
1974
|
-
* </dd>
|
|
1975
|
-
* <dt>PASSWORD_VERIFIER</dt>
|
|
1976
|
-
* <dd>
|
|
1977
|
-
* <p>This challenge response is part of the SRP flow. Amazon Cognito requires
|
|
1978
|
-
* that your application respond to this challenge within a few seconds. When
|
|
1979
|
-
* the response time exceeds this period, your user pool returns a
|
|
1980
|
-
* <code>NotAuthorizedException</code> error.</p>
|
|
1981
|
-
* <p>
|
|
1982
|
-
* <code>"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
|
|
1983
|
-
* \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
|
|
1984
|
-
* "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
|
1985
|
-
* [timestamp], "USERNAME": "[username]"\}</code>
|
|
1986
|
-
* </p>
|
|
1987
|
-
* </dd>
|
|
1988
|
-
* <dt>CUSTOM_CHALLENGE</dt>
|
|
1989
|
-
* <dd>
|
|
1990
|
-
* <p>
|
|
1991
|
-
* <code>"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
|
|
1992
|
-
* \{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"\}</code>
|
|
1993
|
-
* </p>
|
|
1994
|
-
* </dd>
|
|
1995
|
-
* <dt>NEW_PASSWORD_REQUIRED</dt>
|
|
1996
|
-
* <dd>
|
|
1997
|
-
* <p>
|
|
1998
|
-
* <code>"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
|
|
1999
|
-
* \{"NEW_PASSWORD": "[new_password]", "USERNAME":
|
|
2000
|
-
* "[username]"\}</code>
|
|
2001
|
-
* </p>
|
|
2002
|
-
* <p>To set any required attributes that <code>InitiateAuth</code> returned in
|
|
2003
|
-
* an <code>requiredAttributes</code> parameter, add
|
|
2004
|
-
* <code>"userAttributes.[attribute_name]": "[attribute_value]"</code>.
|
|
2005
|
-
* This parameter can also set values for writable attributes that aren't
|
|
2006
|
-
* required by your user pool.</p>
|
|
2007
|
-
* <note>
|
|
2008
|
-
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
2009
|
-
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
2010
|
-
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
2011
|
-
* operation to modify the value of any additional attributes.</p>
|
|
2012
|
-
* </note>
|
|
2013
|
-
* </dd>
|
|
2014
|
-
* <dt>SOFTWARE_TOKEN_MFA</dt>
|
|
2015
|
-
* <dd>
|
|
2016
|
-
* <p>
|
|
2017
|
-
* <code>"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
|
|
2018
|
-
* \{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
|
|
2019
|
-
* [authenticator_code]\}</code>
|
|
2020
|
-
* </p>
|
|
2021
|
-
* </dd>
|
|
2022
|
-
* <dt>DEVICE_SRP_AUTH</dt>
|
|
2023
|
-
* <dd>
|
|
2024
|
-
* <p>
|
|
2025
|
-
* <code>"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": \{"USERNAME":
|
|
2026
|
-
* "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
|
|
2027
|
-
* "[srp_a]"\}</code>
|
|
2028
|
-
* </p>
|
|
2029
|
-
* </dd>
|
|
2030
|
-
* <dt>DEVICE_PASSWORD_VERIFIER</dt>
|
|
2031
|
-
* <dd>
|
|
2032
|
-
* <p>
|
|
2033
|
-
* <code>"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses":
|
|
2034
|
-
* \{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
|
|
2035
|
-
* "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]",
|
|
2036
|
-
* "TIMESTAMP": [timestamp], "USERNAME": "[username]"\}</code>
|
|
2037
|
-
* </p>
|
|
2038
|
-
* </dd>
|
|
2039
|
-
* <dt>MFA_SETUP</dt>
|
|
2040
|
-
* <dd>
|
|
2041
|
-
* <p>
|
|
2042
|
-
* <code>"ChallengeName": "MFA_SETUP", "ChallengeResponses": \{"USERNAME":
|
|
2043
|
-
* "[username]"\}, "SESSION": "[Session ID from
|
|
2044
|
-
* VerifySoftwareToken]"</code>
|
|
2045
|
-
* </p>
|
|
2046
|
-
* </dd>
|
|
2047
|
-
* <dt>SELECT_MFA_TYPE</dt>
|
|
2048
|
-
* <dd>
|
|
2049
|
-
* <p>
|
|
2050
|
-
* <code>"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": \{"USERNAME":
|
|
2051
|
-
* "[username]", "ANSWER": "[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]"\}</code>
|
|
2052
|
-
* </p>
|
|
2053
|
-
* </dd>
|
|
2054
|
-
* </dl>
|
|
2055
|
-
* <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
|
|
2056
|
-
* <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
2057
|
-
* @public
|
|
2058
|
-
*/
|
|
2059
|
-
ChallengeResponses?: Record<string, string> | undefined;
|
|
2060
|
-
/**
|
|
2061
|
-
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
2062
|
-
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
2063
|
-
* email address, or phone number.</p>
|
|
2064
|
-
* @public
|
|
2065
|
-
*/
|
|
2066
|
-
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
2067
|
-
/**
|
|
2068
|
-
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
2069
|
-
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
2070
|
-
* when it makes API requests.</p>
|
|
2071
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
2072
|
-
* applications</a>.</p>
|
|
2073
|
-
* @public
|
|
2074
|
-
*/
|
|
2075
|
-
UserContextData?: UserContextDataType | undefined;
|
|
2076
|
-
/**
|
|
2077
|
-
* <p>A map of custom key-value pairs that you can provide as input for any custom workflows
|
|
2078
|
-
* that this action triggers.</p>
|
|
2079
|
-
* <p>You create custom workflows by assigning Lambda functions to user pool
|
|
2080
|
-
* triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any
|
|
2081
|
-
* functions that are assigned to the following triggers: <i>post
|
|
2082
|
-
* authentication</i>, <i>pre token generation</i>,
|
|
2083
|
-
* <i>define auth challenge</i>, <i>create auth
|
|
2084
|
-
* challenge</i>, and <i>verify auth challenge</i>. When Amazon Cognito
|
|
2085
|
-
* invokes any of these functions, it passes a JSON payload, which the function receives as
|
|
2086
|
-
* input. This payload contains a <code>clientMetadata</code> attribute, which provides the
|
|
2087
|
-
* data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge
|
|
2088
|
-
* request. In your function code in Lambda, you can process the
|
|
2089
|
-
* <code>clientMetadata</code> value to enhance your workflow for your specific
|
|
2090
|
-
* needs.</p>
|
|
2091
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
2092
|
-
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
2093
|
-
* <note>
|
|
2094
|
-
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
2095
|
-
* following:</p>
|
|
2096
|
-
* <ul>
|
|
2097
|
-
* <li>
|
|
2098
|
-
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
2099
|
-
* to Lambda triggers that are assigned to a user pool to support custom
|
|
2100
|
-
* workflows. If your user pool configuration doesn't include triggers, the
|
|
2101
|
-
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
2102
|
-
* </li>
|
|
2103
|
-
* <li>
|
|
2104
|
-
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
2105
|
-
* </li>
|
|
2106
|
-
* <li>
|
|
2107
|
-
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
2108
|
-
* information in this parameter.</p>
|
|
2109
|
-
* </li>
|
|
2110
|
-
* </ul>
|
|
2111
|
-
* </note>
|
|
2112
|
-
* @public
|
|
2113
|
-
*/
|
|
2114
|
-
ClientMetadata?: Record<string, string> | undefined;
|
|
2115
|
-
}
|
|
2116
|
-
/**
|
|
2117
|
-
* <p>The response to respond to the authentication challenge.</p>
|
|
2118
|
-
* @public
|
|
2119
|
-
*/
|
|
2120
|
-
export interface RespondToAuthChallengeResponse {
|
|
2121
|
-
/**
|
|
2122
|
-
* <p>The name of the next challenge that you must respond to.</p>
|
|
2123
|
-
* <p>Possible challenges include the following:</p>
|
|
2124
|
-
* <note>
|
|
2125
|
-
* <p>All of the following challenges require <code>USERNAME</code> and, when the app
|
|
2126
|
-
* client has a client secret, <code>SECRET_HASH</code> in the parameters. Include a
|
|
2127
|
-
* <code>DEVICE_KEY</code> for device authentication.</p>
|
|
2128
|
-
* </note>
|
|
2129
|
-
* <ul>
|
|
2130
|
-
* <li>
|
|
2131
|
-
* <p>
|
|
2132
|
-
* <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
|
|
2133
|
-
* successful authentication with a WebAuthn authenticator, or passkey, as
|
|
2134
|
-
* <code>CREDENTIAL</code>. Examples of WebAuthn authenticators include
|
|
2135
|
-
* biometric devices and security keys.</p>
|
|
2136
|
-
* </li>
|
|
2137
|
-
* <li>
|
|
2138
|
-
* <p>
|
|
2139
|
-
* <code>PASSWORD</code>: Respond with the user's password as <code>PASSWORD</code>.</p>
|
|
2140
|
-
* </li>
|
|
2141
|
-
* <li>
|
|
2142
|
-
* <p>
|
|
2143
|
-
* <code>PASSWORD_SRP</code>: Respond with the initial SRP secret as <code>SRP_A</code>.</p>
|
|
2144
|
-
* </li>
|
|
2145
|
-
* <li>
|
|
2146
|
-
* <p>
|
|
2147
|
-
* <code>SELECT_CHALLENGE</code>: Respond with a challenge selection as <code>ANSWER</code>.
|
|
2148
|
-
* It must be one of the challenge types in the <code>AvailableChallenges</code> response
|
|
2149
|
-
* parameter. Add the parameters of the selected challenge, for example <code>USERNAME</code>
|
|
2150
|
-
* and <code>SMS_OTP</code>.</p>
|
|
2151
|
-
* </li>
|
|
2152
|
-
* <li>
|
|
2153
|
-
* <p>
|
|
2154
|
-
* <code>SMS_MFA</code>: Respond with the code that your user pool delivered in an SMS
|
|
2155
|
-
* message, as <code>SMS_MFA_CODE</code>
|
|
2156
|
-
* </p>
|
|
2157
|
-
* </li>
|
|
2158
|
-
* <li>
|
|
2159
|
-
* <p>
|
|
2160
|
-
* <code>EMAIL_MFA</code>: Respond with the code that your user pool delivered in an email
|
|
2161
|
-
* message, as <code>EMAIL_MFA_CODE</code>
|
|
2162
|
-
* </p>
|
|
2163
|
-
* </li>
|
|
2164
|
-
* <li>
|
|
2165
|
-
* <p>
|
|
2166
|
-
* <code>EMAIL_OTP</code>: Respond with the code that your user pool delivered in an email
|
|
2167
|
-
* message, as <code>EMAIL_OTP_CODE</code> .</p>
|
|
2168
|
-
* </li>
|
|
2169
|
-
* <li>
|
|
2170
|
-
* <p>
|
|
2171
|
-
* <code>SMS_OTP</code>: Respond with the code that your user pool delivered in an SMS
|
|
2172
|
-
* message, as <code>SMS_OTP_CODE</code>.</p>
|
|
2173
|
-
* </li>
|
|
2174
|
-
* <li>
|
|
2175
|
-
* <p>
|
|
2176
|
-
* <code>PASSWORD_VERIFIER</code>: Respond with the second stage of SRP secrets as
|
|
2177
|
-
* <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>,
|
|
2178
|
-
* and <code>TIMESTAMP</code>.</p>
|
|
2179
|
-
* </li>
|
|
2180
|
-
* <li>
|
|
2181
|
-
* <p>
|
|
2182
|
-
* <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
|
|
2183
|
-
* flow determines that the user should pass another challenge before tokens are
|
|
2184
|
-
* issued. The parameters of the challenge are determined by your Lambda function
|
|
2185
|
-
* and issued in the <code>ChallengeParameters</code> of a challenge response.</p>
|
|
2186
|
-
* </li>
|
|
2187
|
-
* <li>
|
|
2188
|
-
* <p>
|
|
2189
|
-
* <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
|
|
2190
|
-
* authentication. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
2191
|
-
* </li>
|
|
2192
|
-
* <li>
|
|
2193
|
-
* <p>
|
|
2194
|
-
* <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
|
|
2195
|
-
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
2196
|
-
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
2197
|
-
* client-side SRP calculations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
2198
|
-
* </li>
|
|
2199
|
-
* <li>
|
|
2200
|
-
* <p>
|
|
2201
|
-
* <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
|
|
2202
|
-
* passwords after successful first login. Respond to this challenge with
|
|
2203
|
-
* <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
|
|
2204
|
-
* the <code>requiredAttributes</code> parameter. You can also set values for
|
|
2205
|
-
* attributes that aren't required by your user pool and that your app client
|
|
2206
|
-
* can write.</p>
|
|
2207
|
-
* <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
|
|
2208
|
-
* When you create passwordless users, you must provide values for all required
|
|
2209
|
-
* attributes.</p>
|
|
2210
|
-
* <note>
|
|
2211
|
-
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
2212
|
-
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
2213
|
-
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
2214
|
-
* operation to modify the value of any additional attributes.</p>
|
|
2215
|
-
* </note>
|
|
2216
|
-
* </li>
|
|
2217
|
-
* <li>
|
|
2218
|
-
* <p>
|
|
2219
|
-
* <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
|
|
2220
|
-
* before they can sign in. The MFA types activated for the user pool will be
|
|
2221
|
-
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
2222
|
-
* <p>To set up time-based one-time password (TOTP) MFA, use the session returned
|
|
2223
|
-
* in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
|
|
2224
|
-
* as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
|
|
2225
|
-
* by <code>VerifySoftwareToken</code> as an input to
|
|
2226
|
-
* <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
|
|
2227
|
-
* with challenge name <code>MFA_SETUP</code> to complete sign-in.
|
|
2228
|
-
* </p>
|
|
2229
|
-
* <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
|
|
2230
|
-
* <code>email</code> attribute for the user. Then restart the authentication
|
|
2231
|
-
* flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
|
|
2232
|
-
* </p>
|
|
2233
|
-
* </li>
|
|
2234
|
-
* </ul>
|
|
2235
|
-
* @public
|
|
2236
|
-
*/
|
|
2237
|
-
ChallengeName?: ChallengeNameType | undefined;
|
|
2238
|
-
/**
|
|
2239
|
-
* <p>The session identifier that maintains the state of authentication requests and
|
|
2240
|
-
* challenge responses. If an <code>InitiateAuth</code> or
|
|
2241
|
-
* <code>RespondToAuthChallenge</code> API request results in a determination that your
|
|
2242
|
-
* application must pass another challenge, Amazon Cognito returns a session with other challenge
|
|
2243
|
-
* parameters. Send this session identifier, unmodified, to the next
|
|
2244
|
-
* <code>RespondToAuthChallenge</code> request.</p>
|
|
2245
|
-
* @public
|
|
2246
|
-
*/
|
|
2247
|
-
Session?: string | undefined;
|
|
2248
|
-
/**
|
|
2249
|
-
* <p>The parameters that define your response to the next challenge.</p>
|
|
2250
|
-
* @public
|
|
2251
|
-
*/
|
|
2252
|
-
ChallengeParameters?: Record<string, string> | undefined;
|
|
2253
|
-
/**
|
|
2254
|
-
* <p>The outcome of a successful authentication process. After your application has passed
|
|
2255
|
-
* all challenges, Amazon Cognito returns an <code>AuthenticationResult</code> with the JSON web
|
|
2256
|
-
* tokens (JWTs) that indicate successful sign-in.</p>
|
|
2257
|
-
* @public
|
|
2258
|
-
*/
|
|
2259
|
-
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
2260
|
-
}
|
|
2261
|
-
/**
|
|
2262
|
-
* @public
|
|
2263
|
-
*/
|
|
2264
|
-
export interface RevokeTokenRequest {
|
|
2265
|
-
/**
|
|
2266
|
-
* <p>The refresh token that you want to revoke.</p>
|
|
2267
|
-
* @public
|
|
2268
|
-
*/
|
|
2269
|
-
Token: string | undefined;
|
|
2270
|
-
/**
|
|
2271
|
-
* <p>The ID of the app client where the token that you want to revoke was issued.</p>
|
|
2272
|
-
* @public
|
|
2273
|
-
*/
|
|
2274
|
-
ClientId: string | undefined;
|
|
2275
|
-
/**
|
|
2276
|
-
* <p>The client secret of the requested app client, if the client has a secret.</p>
|
|
2277
|
-
* @public
|
|
2278
|
-
*/
|
|
2279
|
-
ClientSecret?: string | undefined;
|
|
2280
|
-
}
|
|
2281
|
-
/**
|
|
2282
|
-
* @public
|
|
2283
|
-
*/
|
|
2284
|
-
export interface RevokeTokenResponse {
|
|
2285
|
-
}
|
|
2286
|
-
/**
|
|
2287
|
-
* <p>Exception that is thrown when the request isn't authorized. This can happen due to an
|
|
2288
|
-
* invalid access token in the request.</p>
|
|
2289
|
-
* @public
|
|
2290
|
-
*/
|
|
2291
|
-
export declare class UnauthorizedException extends __BaseException {
|
|
2292
|
-
readonly name: "UnauthorizedException";
|
|
2293
|
-
readonly $fault: "client";
|
|
2294
|
-
/**
|
|
2295
|
-
* @internal
|
|
2296
|
-
*/
|
|
2297
|
-
constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
|
|
2298
|
-
}
|
|
2299
|
-
/**
|
|
2300
|
-
* <p>Exception that is thrown when an unsupported token is passed to an operation.</p>
|
|
2301
|
-
* @public
|
|
2302
|
-
*/
|
|
2303
|
-
export declare class UnsupportedTokenTypeException extends __BaseException {
|
|
2304
|
-
readonly name: "UnsupportedTokenTypeException";
|
|
2305
|
-
readonly $fault: "client";
|
|
2306
|
-
/**
|
|
2307
|
-
* @internal
|
|
2308
|
-
*/
|
|
2309
|
-
constructor(opts: __ExceptionOptionType<UnsupportedTokenTypeException, __BaseException>);
|
|
2310
|
-
}
|
|
2311
|
-
/**
|
|
2312
|
-
* @public
|
|
2313
|
-
*/
|
|
2314
|
-
export interface SetLogDeliveryConfigurationRequest {
|
|
2315
|
-
/**
|
|
2316
|
-
* <p>The ID of the user pool where you want to configure logging.</p>
|
|
2317
|
-
* @public
|
|
2318
|
-
*/
|
|
2319
|
-
UserPoolId: string | undefined;
|
|
2320
|
-
/**
|
|
2321
|
-
* <p>A collection of the logging configurations for a user pool.</p>
|
|
2322
|
-
* @public
|
|
2323
|
-
*/
|
|
2324
|
-
LogConfigurations: LogConfigurationType[] | undefined;
|
|
2325
|
-
}
|
|
2326
|
-
/**
|
|
2327
|
-
* @public
|
|
2328
|
-
*/
|
|
2329
|
-
export interface SetLogDeliveryConfigurationResponse {
|
|
2330
|
-
/**
|
|
2331
|
-
* <p>The logging configuration that you applied to the requested user pool.</p>
|
|
2332
|
-
* @public
|
|
2333
|
-
*/
|
|
2334
|
-
LogDeliveryConfiguration?: LogDeliveryConfigurationType | undefined;
|
|
2335
|
-
}
|
|
2336
|
-
/**
|
|
2337
|
-
* @public
|
|
2338
|
-
*/
|
|
2339
|
-
export interface SetRiskConfigurationRequest {
|
|
2340
|
-
/**
|
|
2341
|
-
* <p>The ID of the user pool where you want to set a risk configuration. If you include
|
|
2342
|
-
* <code>UserPoolId</code> in your request, don't include <code>ClientId</code>.
|
|
2343
|
-
* When the client ID is null, the same risk configuration is applied to all the clients in
|
|
2344
|
-
* the userPool. When you include both <code>ClientId</code> and <code>UserPoolId</code>,
|
|
2345
|
-
* Amazon Cognito maps the configuration to the app client only.</p>
|
|
2346
|
-
* @public
|
|
2347
|
-
*/
|
|
2348
|
-
UserPoolId: string | undefined;
|
|
2349
|
-
/**
|
|
2350
|
-
* <p>The ID of the app client where you want to set a risk configuration. If
|
|
2351
|
-
* <code>ClientId</code> is null, then the risk configuration is mapped to
|
|
2352
|
-
* <code>UserPoolId</code>. When the client ID is null, the same risk configuration is
|
|
2353
|
-
* applied to all the clients in the userPool.</p>
|
|
2354
|
-
* <p>When you include a <code>ClientId</code> parameter, Amazon Cognito maps the configuration to
|
|
2355
|
-
* the app client. When you include both <code>ClientId</code> and <code>UserPoolId</code>,
|
|
2356
|
-
* Amazon Cognito maps the configuration to the app client only.</p>
|
|
2357
|
-
* @public
|
|
2358
|
-
*/
|
|
2359
|
-
ClientId?: string | undefined;
|
|
2360
|
-
/**
|
|
2361
|
-
* <p>The configuration of automated reactions to detected compromised credentials. Includes
|
|
2362
|
-
* settings for blocking future sign-in requests and for the types of password-submission
|
|
2363
|
-
* events you want to monitor.</p>
|
|
2364
|
-
* @public
|
|
2365
|
-
*/
|
|
2366
|
-
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType | undefined;
|
|
2367
|
-
/**
|
|
2368
|
-
* <p>The settings for automated responses and notification templates for adaptive
|
|
2369
|
-
* authentication with threat protection.</p>
|
|
2370
|
-
* @public
|
|
2371
|
-
*/
|
|
2372
|
-
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType | undefined;
|
|
2373
|
-
/**
|
|
2374
|
-
* <p>A set of IP-address overrides to threat protection. You can set up IP-address
|
|
2375
|
-
* always-block and always-allow lists.</p>
|
|
2376
|
-
* @public
|
|
2377
|
-
*/
|
|
2378
|
-
RiskExceptionConfiguration?: RiskExceptionConfigurationType | undefined;
|
|
2379
|
-
}
|
|
2380
|
-
/**
|
|
2381
|
-
* @public
|
|
2382
|
-
*/
|
|
2383
|
-
export interface SetRiskConfigurationResponse {
|
|
2384
|
-
/**
|
|
2385
|
-
* <p>The API response that contains the risk configuration that you set and the timestamp
|
|
2386
|
-
* of the most recent change.</p>
|
|
2387
|
-
* @public
|
|
2388
|
-
*/
|
|
2389
|
-
RiskConfiguration: RiskConfigurationType | undefined;
|
|
2390
|
-
}
|
|
2391
|
-
/**
|
|
2392
|
-
* @public
|
|
2393
|
-
*/
|
|
2394
|
-
export interface SetUICustomizationRequest {
|
|
2395
|
-
/**
|
|
2396
|
-
* <p>The ID of the user pool where you want to apply branding to the classic hosted
|
|
2397
|
-
* UI.</p>
|
|
2398
|
-
* @public
|
|
2399
|
-
*/
|
|
2400
|
-
UserPoolId: string | undefined;
|
|
2401
|
-
/**
|
|
2402
|
-
* <p>The ID of the app client that you want to customize. To apply a default style to all
|
|
2403
|
-
* app clients not configured with client-level branding, set this parameter value to
|
|
2404
|
-
* <code>ALL</code>.</p>
|
|
2405
|
-
* @public
|
|
2406
|
-
*/
|
|
2407
|
-
ClientId?: string | undefined;
|
|
2408
|
-
/**
|
|
2409
|
-
* <p>A plaintext CSS file that contains the custom fields that you want to apply to your
|
|
2410
|
-
* user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to
|
|
2411
|
-
* your user pool <i>App clients</i> tab, select <i>Login
|
|
2412
|
-
* pages</i>, edit <i>Hosted UI (classic) style</i>, and select
|
|
2413
|
-
* the link to <code>CSS template.css</code>.</p>
|
|
2414
|
-
* @public
|
|
2415
|
-
*/
|
|
2416
|
-
CSS?: string | undefined;
|
|
2417
|
-
/**
|
|
2418
|
-
* <p>The image that you want to set as your login in the classic hosted UI, as a
|
|
2419
|
-
* Base64-formatted binary object.</p>
|
|
2420
|
-
* @public
|
|
2421
|
-
*/
|
|
2422
|
-
ImageFile?: Uint8Array | undefined;
|
|
2423
|
-
}
|
|
2424
|
-
/**
|
|
2425
|
-
* @public
|
|
2426
|
-
*/
|
|
2427
|
-
export interface SetUICustomizationResponse {
|
|
2428
|
-
/**
|
|
2429
|
-
* <p>Information about the hosted UI branding that you applied.</p>
|
|
2430
|
-
* @public
|
|
2431
|
-
*/
|
|
2432
|
-
UICustomization: UICustomizationType | undefined;
|
|
2433
|
-
}
|
|
2434
|
-
/**
|
|
2435
|
-
* @public
|
|
2436
|
-
*/
|
|
2437
|
-
export interface SetUserMFAPreferenceRequest {
|
|
2438
|
-
/**
|
|
2439
|
-
* <p>User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as
|
|
2440
|
-
* the preferred MFA method when multiple methods are available.</p>
|
|
2441
|
-
* @public
|
|
2442
|
-
*/
|
|
2443
|
-
SMSMfaSettings?: SMSMfaSettingsType | undefined;
|
|
2444
|
-
/**
|
|
2445
|
-
* <p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates
|
|
2446
|
-
* TOTP MFA and sets it as the preferred MFA method when multiple methods are available.
|
|
2447
|
-
* Users must register a TOTP authenticator before they set this as their preferred MFA
|
|
2448
|
-
* method.</p>
|
|
2449
|
-
* @public
|
|
2450
|
-
*/
|
|
2451
|
-
SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType | undefined;
|
|
2452
|
-
/**
|
|
2453
|
-
* <p>User preferences for email message MFA. Activates or deactivates email MFA and sets it
|
|
2454
|
-
* as the preferred MFA method when multiple methods are available.
|
|
2455
|
-
* 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">
|
|
2456
|
-
* Essentials tier</a> or higher.</p>
|
|
2457
|
-
* @public
|
|
2458
|
-
*/
|
|
2459
|
-
EmailMfaSettings?: EmailMfaSettingsType | undefined;
|
|
2460
|
-
/**
|
|
2461
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
2462
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
2463
|
-
* @public
|
|
2464
|
-
*/
|
|
2465
|
-
AccessToken: string | undefined;
|
|
2466
|
-
}
|
|
2467
|
-
/**
|
|
2468
|
-
* @public
|
|
2469
|
-
*/
|
|
2470
|
-
export interface SetUserMFAPreferenceResponse {
|
|
2471
|
-
}
|
|
2472
|
-
/**
|
|
2473
|
-
* @public
|
|
2474
|
-
*/
|
|
2475
|
-
export interface SetUserPoolMfaConfigRequest {
|
|
2476
|
-
/**
|
|
2477
|
-
* <p>The user pool ID.</p>
|
|
2478
|
-
* @public
|
|
2479
|
-
*/
|
|
2480
|
-
UserPoolId: string | undefined;
|
|
2481
|
-
/**
|
|
2482
|
-
* <p>Configures user pool SMS messages for MFA. Sets the message template and the SMS
|
|
2483
|
-
* message sending configuration for Amazon SNS.</p>
|
|
2484
|
-
* @public
|
|
2485
|
-
*/
|
|
2486
|
-
SmsMfaConfiguration?: SmsMfaConfigType | undefined;
|
|
2487
|
-
/**
|
|
2488
|
-
* <p>Configures a user pool for time-based one-time password (TOTP) MFA. Enables or
|
|
2489
|
-
* disables TOTP.</p>
|
|
2490
|
-
* @public
|
|
2491
|
-
*/
|
|
2492
|
-
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
|
|
2493
|
-
/**
|
|
2494
|
-
* <p>Sets configuration for user pool email message MFA and sign-in with one-time passwords
|
|
2495
|
-
* (OTPs). Includes the subject and body of the email message template for sign-in and MFA
|
|
2496
|
-
* messages. 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">
|
|
2497
|
-
* Essentials tier</a> or higher.</p>
|
|
2498
|
-
* @public
|
|
2499
|
-
*/
|
|
2500
|
-
EmailMfaConfiguration?: EmailMfaConfigType | undefined;
|
|
2501
|
-
/**
|
|
2502
|
-
* <p>Sets multi-factor authentication (MFA) to be on, off, or optional. When
|
|
2503
|
-
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
2504
|
-
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
2505
|
-
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
2506
|
-
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
2507
|
-
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
2508
|
-
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
2509
|
-
* API responses and in managed login for users who have chosen and configured a preferred
|
|
2510
|
-
* MFA factor.</p>
|
|
2511
|
-
* @public
|
|
2512
|
-
*/
|
|
2513
|
-
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
2514
|
-
/**
|
|
2515
|
-
* <p>The configuration of your user pool for passkey, or WebAuthn, authentication and
|
|
2516
|
-
* registration. You can set this configuration independent of the MFA configuration
|
|
2517
|
-
* options in this operation.</p>
|
|
2518
|
-
* @public
|
|
2519
|
-
*/
|
|
2520
|
-
WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
|
|
2521
|
-
}
|
|
2522
|
-
/**
|
|
2523
|
-
* @public
|
|
2524
|
-
*/
|
|
2525
|
-
export interface SetUserPoolMfaConfigResponse {
|
|
2526
|
-
/**
|
|
2527
|
-
* <p>Shows user pool SMS message configuration for MFA and sign-in with SMS-message OTPs.
|
|
2528
|
-
* Includes the message template and the SMS message sending configuration for
|
|
2529
|
-
* Amazon SNS.</p>
|
|
2530
|
-
* @public
|
|
2531
|
-
*/
|
|
2532
|
-
SmsMfaConfiguration?: SmsMfaConfigType | undefined;
|
|
2533
|
-
/**
|
|
2534
|
-
* <p>Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes
|
|
2535
|
-
* TOTP enabled or disabled state.</p>
|
|
2536
|
-
* @public
|
|
2537
|
-
*/
|
|
2538
|
-
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
|
|
2539
|
-
/**
|
|
2540
|
-
* <p>Shows configuration for user pool email message MFA and sign-in with one-time
|
|
2541
|
-
* passwords (OTPs). Includes the subject and body of the email message template for
|
|
2542
|
-
* sign-in and MFA messages. 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">
|
|
2543
|
-
* Essentials tier</a> or higher.</p>
|
|
2544
|
-
* @public
|
|
2545
|
-
*/
|
|
2546
|
-
EmailMfaConfiguration?: EmailMfaConfigType | undefined;
|
|
2547
|
-
/**
|
|
2548
|
-
* <p>Displays multi-factor authentication (MFA) as on, off, or optional. When
|
|
2549
|
-
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
2550
|
-
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
2551
|
-
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
2552
|
-
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
2553
|
-
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
2554
|
-
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
2555
|
-
* API responses and in managed login for users who have chosen and configured a preferred
|
|
2556
|
-
* MFA factor.</p>
|
|
2557
|
-
* @public
|
|
2558
|
-
*/
|
|
2559
|
-
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
2560
|
-
/**
|
|
2561
|
-
* <p>The configuration of your user pool for passkey, or WebAuthn, sign-in with
|
|
2562
|
-
* authenticators like biometric and security-key devices. Includes relying-party
|
|
2563
|
-
* configuration and settings for user-verification requirements.</p>
|
|
2564
|
-
* @public
|
|
2565
|
-
*/
|
|
2566
|
-
WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
|
|
2567
|
-
}
|
|
2568
|
-
/**
|
|
2569
|
-
* <p>Represents the request to set user settings.</p>
|
|
2570
|
-
* @public
|
|
2571
|
-
*/
|
|
2572
|
-
export interface SetUserSettingsRequest {
|
|
2573
|
-
/**
|
|
2574
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
2575
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
2576
|
-
* @public
|
|
2577
|
-
*/
|
|
2578
|
-
AccessToken: string | undefined;
|
|
2579
|
-
/**
|
|
2580
|
-
* <p>You can use this parameter only to set an SMS configuration that uses SMS for
|
|
2581
|
-
* delivery.</p>
|
|
2582
|
-
* @public
|
|
2583
|
-
*/
|
|
2584
|
-
MFAOptions: MFAOptionType[] | undefined;
|
|
2585
|
-
}
|
|
2586
|
-
/**
|
|
2587
|
-
* <p>The response from the server for a set user settings request.</p>
|
|
2588
|
-
* @public
|
|
2589
|
-
*/
|
|
2590
|
-
export interface SetUserSettingsResponse {
|
|
2591
|
-
}
|
|
2592
|
-
/**
|
|
2593
|
-
* <p>Represents the request to register a user.</p>
|
|
2594
|
-
* @public
|
|
2595
|
-
*/
|
|
2596
|
-
export interface SignUpRequest {
|
|
2597
|
-
/**
|
|
2598
|
-
* <p>The ID of the app client where the user wants to sign up.</p>
|
|
2599
|
-
* @public
|
|
2600
|
-
*/
|
|
2601
|
-
ClientId: string | undefined;
|
|
2602
|
-
/**
|
|
2603
|
-
* <p>A keyed-hash message authentication code (HMAC) calculated using the secret key of a
|
|
2604
|
-
* user pool client and username plus the client ID in the message. For more information
|
|
2605
|
-
* about <code>SecretHash</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>.</p>
|
|
2606
|
-
* @public
|
|
2607
|
-
*/
|
|
2608
|
-
SecretHash?: string | undefined;
|
|
2609
|
-
/**
|
|
2610
|
-
* <p>The username of the user that you want to sign up. The value of this parameter is
|
|
2611
|
-
* typically a username, but can be any alias attribute in your user pool.</p>
|
|
2612
|
-
* @public
|
|
2613
|
-
*/
|
|
2614
|
-
Username: string | undefined;
|
|
2615
|
-
/**
|
|
2616
|
-
* <p>The user's proposed password. The password must comply with the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users-passwords.html">password requirements</a> of your user pool.</p>
|
|
2617
|
-
* <p>Users can sign up without a password when your user pool supports passwordless sign-in
|
|
2618
|
-
* with email or SMS OTPs. To create a user with no password, omit this parameter or submit
|
|
2619
|
-
* a blank value. You can only create a passwordless user when passwordless sign-in is
|
|
2620
|
-
* available.</p>
|
|
2621
|
-
* @public
|
|
2622
|
-
*/
|
|
2623
|
-
Password?: string | undefined;
|
|
2624
|
-
/**
|
|
2625
|
-
* <p>An array of name-value pairs representing user attributes.</p>
|
|
2626
|
-
* <p>For custom attributes, include a <code>custom:</code> prefix in the attribute name,
|
|
2627
|
-
* for example <code>custom:department</code>.</p>
|
|
2628
|
-
* @public
|
|
2629
|
-
*/
|
|
2630
|
-
UserAttributes?: AttributeType[] | undefined;
|
|
2631
|
-
/**
|
|
2632
|
-
* <p>Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda
|
|
2633
|
-
* trigger. This set of key-value pairs are for custom validation of information that you
|
|
2634
|
-
* collect from your users but don't need to retain.</p>
|
|
2635
|
-
* <p>Your Lambda function can analyze this additional data and act on it. Your function
|
|
2636
|
-
* can automatically confirm and verify select users or perform external API operations
|
|
2637
|
-
* like logging user attributes and validation data to Amazon CloudWatch Logs.</p>
|
|
2638
|
-
* <p>For more information about the pre sign-up Lambda trigger, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html">Pre sign-up Lambda trigger</a>.</p>
|
|
2639
|
-
* @public
|
|
2640
|
-
*/
|
|
2641
|
-
ValidationData?: AttributeType[] | undefined;
|
|
2642
|
-
/**
|
|
2643
|
-
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
2644
|
-
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
2645
|
-
* email address, or phone number.</p>
|
|
2646
|
-
* @public
|
|
2647
|
-
*/
|
|
2648
|
-
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
2649
|
-
/**
|
|
2650
|
-
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
2651
|
-
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
2652
|
-
* when it makes API requests.</p>
|
|
2653
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
2654
|
-
* applications</a>.</p>
|
|
2655
|
-
* @public
|
|
2656
|
-
*/
|
|
2657
|
-
UserContextData?: UserContextDataType | undefined;
|
|
2658
|
-
/**
|
|
2659
|
-
* <p>A map of custom key-value pairs that you can provide as input for any custom workflows
|
|
2660
|
-
* that this action triggers.</p>
|
|
2661
|
-
* <p>You create custom workflows by assigning Lambda functions to user pool triggers.
|
|
2662
|
-
* When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the
|
|
2663
|
-
* following triggers: <i>pre sign-up</i>, <i>custom
|
|
2664
|
-
* message</i>, and <i>post confirmation</i>. When Amazon Cognito invokes
|
|
2665
|
-
* any of these functions, it passes a JSON payload, which the function receives as input.
|
|
2666
|
-
* This payload contains a <code>clientMetadata</code> attribute, which provides the data
|
|
2667
|
-
* that you assigned to the ClientMetadata parameter in your SignUp request. In your
|
|
2668
|
-
* function code in Lambda, you can process the <code>clientMetadata</code> value to enhance
|
|
2669
|
-
* your workflow for your specific needs.</p>
|
|
2670
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
2671
|
-
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
2672
|
-
* <note>
|
|
2673
|
-
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
2674
|
-
* following:</p>
|
|
2675
|
-
* <ul>
|
|
2676
|
-
* <li>
|
|
2677
|
-
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
2678
|
-
* to Lambda triggers that are assigned to a user pool to support custom
|
|
2679
|
-
* workflows. If your user pool configuration doesn't include triggers, the
|
|
2680
|
-
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
2681
|
-
* </li>
|
|
2682
|
-
* <li>
|
|
2683
|
-
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
2684
|
-
* </li>
|
|
2685
|
-
* <li>
|
|
2686
|
-
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
2687
|
-
* information in this parameter.</p>
|
|
2688
|
-
* </li>
|
|
2689
|
-
* </ul>
|
|
2690
|
-
* </note>
|
|
2691
|
-
* @public
|
|
2692
|
-
*/
|
|
2693
|
-
ClientMetadata?: Record<string, string> | undefined;
|
|
2694
|
-
}
|
|
2695
|
-
/**
|
|
2696
|
-
* <p>The response from the server for a registration request.</p>
|
|
2697
|
-
* @public
|
|
2698
|
-
*/
|
|
2699
|
-
export interface SignUpResponse {
|
|
2700
|
-
/**
|
|
2701
|
-
* <p>Indicates whether the user was automatically confirmed. You can auto-confirm users
|
|
2702
|
-
* with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html">pre sign-up Lambda trigger</a>.</p>
|
|
2703
|
-
* @public
|
|
2704
|
-
*/
|
|
2705
|
-
UserConfirmed: boolean | undefined;
|
|
2706
|
-
/**
|
|
2707
|
-
* <p>In user pools that automatically verify and confirm new users, Amazon Cognito sends users a
|
|
2708
|
-
* message with a code or link that confirms ownership of the phone number or email address
|
|
2709
|
-
* that they entered. The <code>CodeDeliveryDetails</code> object is information about the
|
|
2710
|
-
* delivery destination for that link or code.</p>
|
|
2711
|
-
* @public
|
|
2712
|
-
*/
|
|
2713
|
-
CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
|
|
2714
|
-
/**
|
|
2715
|
-
* <p>The unique identifier of the new user, for example
|
|
2716
|
-
* <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
2717
|
-
* @public
|
|
2718
|
-
*/
|
|
2719
|
-
UserSub: string | undefined;
|
|
2720
|
-
/**
|
|
2721
|
-
* <p>A session Id that you can pass to <code>ConfirmSignUp</code> when you want to
|
|
2722
|
-
* immediately sign in your user with the <code>USER_AUTH</code> flow after they complete
|
|
2723
|
-
* sign-up.</p>
|
|
2724
|
-
* @public
|
|
2725
|
-
*/
|
|
2726
|
-
Session?: string | undefined;
|
|
2727
|
-
}
|
|
2728
|
-
/**
|
|
2729
|
-
* <p>Represents the request to start the user import job.</p>
|
|
2730
|
-
* @public
|
|
2731
|
-
*/
|
|
2732
|
-
export interface StartUserImportJobRequest {
|
|
2733
|
-
/**
|
|
2734
|
-
* <p>The ID of the user pool that you want to start importing users into.</p>
|
|
2735
|
-
* @public
|
|
2736
|
-
*/
|
|
2737
|
-
UserPoolId: string | undefined;
|
|
2738
|
-
/**
|
|
2739
|
-
* <p>The ID of a user import job that you previously created.</p>
|
|
2740
|
-
* @public
|
|
2741
|
-
*/
|
|
2742
|
-
JobId: string | undefined;
|
|
2743
|
-
}
|
|
2744
|
-
/**
|
|
2745
|
-
* <p>Represents the response from the server to the request to start the user import
|
|
2746
|
-
* job.</p>
|
|
2747
|
-
* @public
|
|
2748
|
-
*/
|
|
2749
|
-
export interface StartUserImportJobResponse {
|
|
2750
|
-
/**
|
|
2751
|
-
* <p>The details of the user import job. Includes logging destination, status, and the Amazon S3
|
|
2752
|
-
* pre-signed URL for CSV upload.</p>
|
|
2753
|
-
* @public
|
|
2754
|
-
*/
|
|
2755
|
-
UserImportJob?: UserImportJobType | undefined;
|
|
2756
|
-
}
|
|
2757
|
-
/**
|
|
2758
|
-
* @public
|
|
2759
|
-
*/
|
|
2760
|
-
export interface StartWebAuthnRegistrationRequest {
|
|
2761
|
-
/**
|
|
2762
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
2763
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
2764
|
-
* @public
|
|
2765
|
-
*/
|
|
2766
|
-
AccessToken: string | undefined;
|
|
2767
|
-
}
|
|
2768
|
-
/**
|
|
2769
|
-
* @public
|
|
2770
|
-
*/
|
|
2771
|
-
export interface StartWebAuthnRegistrationResponse {
|
|
2772
|
-
/**
|
|
2773
|
-
* <p>The information that a user can provide in their request to register with their
|
|
2774
|
-
* passkey provider.</p>
|
|
2775
|
-
* @public
|
|
2776
|
-
*/
|
|
2777
|
-
CredentialCreationOptions: __DocumentType | undefined;
|
|
2778
|
-
}
|
|
2779
|
-
/**
|
|
2780
|
-
* <p>This exception is thrown when a user pool doesn't have a configured relying party
|
|
2781
|
-
* id or a user pool domain.</p>
|
|
2782
|
-
* @public
|
|
2783
|
-
*/
|
|
2784
|
-
export declare class WebAuthnConfigurationMissingException extends __BaseException {
|
|
2785
|
-
readonly name: "WebAuthnConfigurationMissingException";
|
|
2786
|
-
readonly $fault: "client";
|
|
2787
|
-
/**
|
|
2788
|
-
* @internal
|
|
2789
|
-
*/
|
|
2790
|
-
constructor(opts: __ExceptionOptionType<WebAuthnConfigurationMissingException, __BaseException>);
|
|
2791
|
-
}
|
|
2792
|
-
/**
|
|
2793
|
-
* <p>Represents the request to stop the user import job.</p>
|
|
2794
|
-
* @public
|
|
2795
|
-
*/
|
|
2796
|
-
export interface StopUserImportJobRequest {
|
|
2797
|
-
/**
|
|
2798
|
-
* <p>The ID of the user pool that you want to stop.</p>
|
|
2799
|
-
* @public
|
|
2800
|
-
*/
|
|
2801
|
-
UserPoolId: string | undefined;
|
|
2802
|
-
/**
|
|
2803
|
-
* <p>The ID of a running user import job.</p>
|
|
2804
|
-
* @public
|
|
2805
|
-
*/
|
|
2806
|
-
JobId: string | undefined;
|
|
2807
|
-
}
|
|
2808
|
-
/**
|
|
2809
|
-
* <p>Represents the response from the server to the request to stop the user import
|
|
2810
|
-
* job.</p>
|
|
2811
|
-
* @public
|
|
2812
|
-
*/
|
|
2813
|
-
export interface StopUserImportJobResponse {
|
|
2814
|
-
/**
|
|
2815
|
-
* <p>The details of the user import job. Includes logging destination, status, and the Amazon S3
|
|
2816
|
-
* pre-signed URL for CSV upload.</p>
|
|
2817
|
-
* @public
|
|
2818
|
-
*/
|
|
2819
|
-
UserImportJob?: UserImportJobType | undefined;
|
|
2820
|
-
}
|
|
2821
|
-
/**
|
|
2822
|
-
* @public
|
|
2823
|
-
*/
|
|
2824
|
-
export interface TagResourceRequest {
|
|
2825
|
-
/**
|
|
2826
|
-
* <p>The Amazon Resource Name (ARN) of the user pool to assign the tags to.</p>
|
|
2827
|
-
* @public
|
|
2828
|
-
*/
|
|
2829
|
-
ResourceArn: string | undefined;
|
|
2830
|
-
/**
|
|
2831
|
-
* <p>An array of tag keys and values that you want to assign to the user pool.</p>
|
|
2832
|
-
* @public
|
|
2833
|
-
*/
|
|
2834
|
-
Tags: Record<string, string> | undefined;
|
|
2835
|
-
}
|
|
2836
|
-
/**
|
|
2837
|
-
* @public
|
|
2838
|
-
*/
|
|
2839
|
-
export interface TagResourceResponse {
|
|
2840
|
-
}
|
|
2841
|
-
/**
|
|
2842
|
-
* @public
|
|
2843
|
-
*/
|
|
2844
|
-
export interface UntagResourceRequest {
|
|
2845
|
-
/**
|
|
2846
|
-
* <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
|
|
2847
|
-
* @public
|
|
2848
|
-
*/
|
|
2849
|
-
ResourceArn: string | undefined;
|
|
2850
|
-
/**
|
|
2851
|
-
* <p>An array of tag keys that you want to remove from the user pool.</p>
|
|
2852
|
-
* @public
|
|
2853
|
-
*/
|
|
2854
|
-
TagKeys: string[] | undefined;
|
|
2855
|
-
}
|
|
2856
|
-
/**
|
|
2857
|
-
* @public
|
|
2858
|
-
*/
|
|
2859
|
-
export interface UntagResourceResponse {
|
|
2860
|
-
}
|
|
2861
|
-
/**
|
|
2862
|
-
* @public
|
|
2863
|
-
*/
|
|
2864
|
-
export interface UpdateAuthEventFeedbackRequest {
|
|
2865
|
-
/**
|
|
2866
|
-
* <p>The ID of the user pool where you want to update auth event feedback.</p>
|
|
2867
|
-
* @public
|
|
2868
|
-
*/
|
|
2869
|
-
UserPoolId: string | undefined;
|
|
2870
|
-
/**
|
|
2871
|
-
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
2872
|
-
* is typically your user's username, but it can be any of their alias attributes. If
|
|
2873
|
-
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
2874
|
-
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
2875
|
-
* third-party IdP.</p>
|
|
2876
|
-
* @public
|
|
2877
|
-
*/
|
|
2878
|
-
Username: string | undefined;
|
|
2879
|
-
/**
|
|
2880
|
-
* <p>The ID of the authentication event that you want to submit feedback for.</p>
|
|
2881
|
-
* @public
|
|
2882
|
-
*/
|
|
2883
|
-
EventId: string | undefined;
|
|
2884
|
-
/**
|
|
2885
|
-
* <p>The feedback token, an encrypted object generated by Amazon Cognito and passed to your user in
|
|
2886
|
-
* the notification email message from the event.</p>
|
|
2887
|
-
* @public
|
|
2888
|
-
*/
|
|
2889
|
-
FeedbackToken: string | undefined;
|
|
2890
|
-
/**
|
|
2891
|
-
* <p>Your feedback to the authentication event. When you provide a <code>FeedbackValue</code>
|
|
2892
|
-
* value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito
|
|
2893
|
-
* has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of
|
|
2894
|
-
* <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you
|
|
2895
|
-
* don't believe that Amazon Cognito evaluated a high-enough risk level.</p>
|
|
2896
|
-
* @public
|
|
2897
|
-
*/
|
|
2898
|
-
FeedbackValue: FeedbackValueType | undefined;
|
|
2899
|
-
}
|
|
2900
|
-
/**
|
|
2901
|
-
* @public
|
|
2902
|
-
*/
|
|
2903
|
-
export interface UpdateAuthEventFeedbackResponse {
|
|
2904
|
-
}
|
|
2905
|
-
/**
|
|
2906
|
-
* <p>Represents the request to update the device status.</p>
|
|
2907
|
-
* @public
|
|
2908
|
-
*/
|
|
2909
|
-
export interface UpdateDeviceStatusRequest {
|
|
2910
|
-
/**
|
|
2911
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
2912
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
2913
|
-
* @public
|
|
2914
|
-
*/
|
|
2915
|
-
AccessToken: string | undefined;
|
|
2916
|
-
/**
|
|
2917
|
-
* <p>The device key of the device you want to update, for example
|
|
2918
|
-
* <code>us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
2919
|
-
* @public
|
|
2920
|
-
*/
|
|
2921
|
-
DeviceKey: string | undefined;
|
|
2922
|
-
/**
|
|
2923
|
-
* <p>To enable device authentication with the specified device, set to
|
|
2924
|
-
* <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>
|
|
2925
|
-
* @public
|
|
2926
|
-
*/
|
|
2927
|
-
DeviceRememberedStatus?: DeviceRememberedStatusType | undefined;
|
|
2928
|
-
}
|
|
2929
|
-
/**
|
|
2930
|
-
* <p>The response to the request to update the device status.</p>
|
|
2931
|
-
* @public
|
|
2932
|
-
*/
|
|
2933
|
-
export interface UpdateDeviceStatusResponse {
|
|
2934
|
-
}
|
|
2935
|
-
/**
|
|
2936
|
-
* @public
|
|
2937
|
-
*/
|
|
2938
|
-
export interface UpdateGroupRequest {
|
|
2939
|
-
/**
|
|
2940
|
-
* <p>The name of the group that you want to update.</p>
|
|
2941
|
-
* @public
|
|
2942
|
-
*/
|
|
2943
|
-
GroupName: string | undefined;
|
|
2944
|
-
/**
|
|
2945
|
-
* <p>The ID of the user pool that contains the group you want to update.</p>
|
|
2946
|
-
* @public
|
|
2947
|
-
*/
|
|
2948
|
-
UserPoolId: string | undefined;
|
|
2949
|
-
/**
|
|
2950
|
-
* <p>A new description of the existing group.</p>
|
|
2951
|
-
* @public
|
|
2952
|
-
*/
|
|
2953
|
-
Description?: string | undefined;
|
|
2954
|
-
/**
|
|
2955
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that you want to associate with the
|
|
2956
|
-
* group. The role assignment contributes to the <code>cognito:roles</code> and
|
|
2957
|
-
* <code>cognito:preferred_role</code> claims in group members' tokens.</p>
|
|
2958
|
-
* @public
|
|
2959
|
-
*/
|
|
2960
|
-
RoleArn?: string | undefined;
|
|
2961
|
-
/**
|
|
2962
|
-
* <p>A non-negative integer value that specifies the precedence of this group relative to
|
|
2963
|
-
* the other groups that a user can belong to in the user pool. Zero is the highest
|
|
2964
|
-
* precedence value. Groups with lower <code>Precedence</code> values take precedence over
|
|
2965
|
-
* groups with higher or null <code>Precedence</code> values. If a user belongs to two or
|
|
2966
|
-
* more groups, it is the group with the lowest precedence value whose role ARN is given in
|
|
2967
|
-
* the user's tokens for the <code>cognito:roles</code> and
|
|
2968
|
-
* <code>cognito:preferred_role</code> claims.</p>
|
|
2969
|
-
* <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither
|
|
2970
|
-
* group takes precedence over the other. If two groups with the same
|
|
2971
|
-
* <code>Precedence</code> have the same role ARN, that role is used in the
|
|
2972
|
-
* <code>cognito:preferred_role</code> claim in tokens for users in each group. If the
|
|
2973
|
-
* two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't
|
|
2974
|
-
* set in users' tokens.</p>
|
|
2975
|
-
* <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code>
|
|
2976
|
-
* value is <code>2^31-1</code>.</p>
|
|
2977
|
-
* @public
|
|
2978
|
-
*/
|
|
2979
|
-
Precedence?: number | undefined;
|
|
2980
|
-
}
|
|
2981
|
-
/**
|
|
2982
|
-
* @public
|
|
2983
|
-
*/
|
|
2984
|
-
export interface UpdateGroupResponse {
|
|
2985
|
-
/**
|
|
2986
|
-
* <p>Contains the updated details of the group, including precedence, IAM role, and
|
|
2987
|
-
* description.</p>
|
|
2988
|
-
* @public
|
|
2989
|
-
*/
|
|
2990
|
-
Group?: GroupType | undefined;
|
|
2991
|
-
}
|
|
2992
|
-
/**
|
|
2993
|
-
* @public
|
|
2994
|
-
*/
|
|
2995
|
-
export interface UpdateIdentityProviderRequest {
|
|
2996
|
-
/**
|
|
2997
|
-
* <p>The Id of the user pool where you want to update your IdP.</p>
|
|
2998
|
-
* @public
|
|
2999
|
-
*/
|
|
3000
|
-
UserPoolId: string | undefined;
|
|
3001
|
-
/**
|
|
3002
|
-
* <p>The name of the IdP that you want to update. You can pass the identity provider name
|
|
3003
|
-
* in the <code>identity_provider</code> query parameter of requests to the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html">Authorize endpoint</a> to silently redirect to sign-in with the associated
|
|
3004
|
-
* IdP.</p>
|
|
3005
|
-
* @public
|
|
3006
|
-
*/
|
|
3007
|
-
ProviderName: string | undefined;
|
|
3008
|
-
/**
|
|
3009
|
-
* <p>The scopes, URLs, and identifiers for your external identity provider. The following
|
|
3010
|
-
* examples describe the provider detail keys for each IdP type. These values and their
|
|
3011
|
-
* schema are subject to change. Social IdP <code>authorize_scopes</code> values must match
|
|
3012
|
-
* the values listed here.</p>
|
|
3013
|
-
* <dl>
|
|
3014
|
-
* <dt>OpenID Connect (OIDC)</dt>
|
|
3015
|
-
* <dd>
|
|
3016
|
-
* <p>Amazon Cognito accepts the following elements when it can't discover endpoint
|
|
3017
|
-
* URLs from <code>oidc_issuer</code>: <code>attributes_url</code>,
|
|
3018
|
-
* <code>authorize_url</code>, <code>jwks_uri</code>,
|
|
3019
|
-
* <code>token_url</code>.</p>
|
|
3020
|
-
* <p>Create or update request: <code>"ProviderDetails": \{
|
|
3021
|
-
* "attributes_request_method": "GET", "attributes_url":
|
|
3022
|
-
* "https://auth.example.com/userInfo", "authorize_scopes": "openid profile
|
|
3023
|
-
* email", "authorize_url": "https://auth.example.com/authorize",
|
|
3024
|
-
* "client_id": "1example23456789", "client_secret":
|
|
3025
|
-
* "provider-app-client-secret", "jwks_uri":
|
|
3026
|
-
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
|
|
3027
|
-
* "https://auth.example.com", "token_url": "https://example.com/token"
|
|
3028
|
-
* \}</code>
|
|
3029
|
-
* </p>
|
|
3030
|
-
* <p>Describe response: <code>"ProviderDetails": \{ "attributes_request_method":
|
|
3031
|
-
* "GET", "attributes_url": "https://auth.example.com/userInfo",
|
|
3032
|
-
* "attributes_url_add_attributes": "false", "authorize_scopes": "openid
|
|
3033
|
-
* profile email", "authorize_url": "https://auth.example.com/authorize",
|
|
3034
|
-
* "client_id": "1example23456789", "client_secret":
|
|
3035
|
-
* "provider-app-client-secret", "jwks_uri":
|
|
3036
|
-
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
|
|
3037
|
-
* "https://auth.example.com", "token_url": "https://example.com/token"
|
|
3038
|
-
* \}</code>
|
|
3039
|
-
* </p>
|
|
3040
|
-
* </dd>
|
|
3041
|
-
* <dt>SAML</dt>
|
|
3042
|
-
* <dd>
|
|
3043
|
-
* <p>Create or update request with Metadata URL: <code>"ProviderDetails": \{ "IDPInit": "true",
|
|
3044
|
-
* "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL":
|
|
3045
|
-
* "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
|
|
3046
|
-
* "rsa-sha256" \}</code>
|
|
3047
|
-
* </p>
|
|
3048
|
-
* <p>Create or update request with Metadata file: <code>"ProviderDetails": \{ "IDPInit": "true",
|
|
3049
|
-
* "IDPSignout": "true", "EncryptedResponses" : "true",
|
|
3050
|
-
* "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm":
|
|
3051
|
-
* "rsa-sha256" \}</code>
|
|
3052
|
-
* </p>
|
|
3053
|
-
* <p>The value of <code>MetadataFile</code> must be the plaintext metadata document with all
|
|
3054
|
-
* quote (") characters escaped by backslashes.</p>
|
|
3055
|
-
* <p>Describe response: <code>"ProviderDetails": \{ "IDPInit": "true",
|
|
3056
|
-
* "IDPSignout": "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": "[certificate]",
|
|
3057
|
-
* "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
|
|
3058
|
-
* "rsa-sha256", "SLORedirectBindingURI":
|
|
3059
|
-
* "https://auth.example.com/slo/saml", "SSORedirectBindingURI":
|
|
3060
|
-
* "https://auth.example.com/sso/saml" \}</code>
|
|
3061
|
-
* </p>
|
|
3062
|
-
* </dd>
|
|
3063
|
-
* <dt>LoginWithAmazon</dt>
|
|
3064
|
-
* <dd>
|
|
3065
|
-
* <p>Create or update request: <code>"ProviderDetails": \{ "authorize_scopes":
|
|
3066
|
-
* "profile postal_code", "client_id":
|
|
3067
|
-
* "amzn1.application-oa2-client.1example23456789", "client_secret":
|
|
3068
|
-
* "provider-app-client-secret"</code>
|
|
3069
|
-
* </p>
|
|
3070
|
-
* <p>Describe response: <code>"ProviderDetails": \{ "attributes_url":
|
|
3071
|
-
* "https://api.amazon.com/user/profile", "attributes_url_add_attributes":
|
|
3072
|
-
* "false", "authorize_scopes": "profile postal_code", "authorize_url":
|
|
3073
|
-
* "https://www.amazon.com/ap/oa", "client_id":
|
|
3074
|
-
* "amzn1.application-oa2-client.1example23456789", "client_secret":
|
|
3075
|
-
* "provider-app-client-secret", "token_request_method": "POST",
|
|
3076
|
-
* "token_url": "https://api.amazon.com/auth/o2/token" \}</code>
|
|
3077
|
-
* </p>
|
|
3078
|
-
* </dd>
|
|
3079
|
-
* <dt>Google</dt>
|
|
3080
|
-
* <dd>
|
|
3081
|
-
* <p>Create or update request: <code>"ProviderDetails": \{ "authorize_scopes":
|
|
3082
|
-
* "email profile openid", "client_id":
|
|
3083
|
-
* "1example23456789.apps.googleusercontent.com", "client_secret":
|
|
3084
|
-
* "provider-app-client-secret" \}</code>
|
|
3085
|
-
* </p>
|
|
3086
|
-
* <p>Describe response: <code>"ProviderDetails": \{ "attributes_url":
|
|
3087
|
-
* "https://people.googleapis.com/v1/people/me?personFields=",
|
|
3088
|
-
* "attributes_url_add_attributes": "true", "authorize_scopes": "email
|
|
3089
|
-
* profile openid", "authorize_url":
|
|
3090
|
-
* "https://accounts.google.com/o/oauth2/v2/auth", "client_id":
|
|
3091
|
-
* "1example23456789.apps.googleusercontent.com", "client_secret":
|
|
3092
|
-
* "provider-app-client-secret", "oidc_issuer":
|
|
3093
|
-
* "https://accounts.google.com", "token_request_method": "POST",
|
|
3094
|
-
* "token_url": "https://www.googleapis.com/oauth2/v4/token"
|
|
3095
|
-
* \}</code>
|
|
3096
|
-
* </p>
|
|
3097
|
-
* </dd>
|
|
3098
|
-
* <dt>SignInWithApple</dt>
|
|
3099
|
-
* <dd>
|
|
3100
|
-
* <p>Create or update request: <code>"ProviderDetails": \{ "authorize_scopes":
|
|
3101
|
-
* "email name", "client_id": "com.example.cognito", "private_key": "1EXAMPLE",
|
|
3102
|
-
* "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" \}</code>
|
|
3103
|
-
* </p>
|
|
3104
|
-
* <p>Describe response: <code>"ProviderDetails": \{
|
|
3105
|
-
* "attributes_url_add_attributes": "false", "authorize_scopes": "email
|
|
3106
|
-
* name", "authorize_url": "https://appleid.apple.com/auth/authorize",
|
|
3107
|
-
* "client_id": "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer":
|
|
3108
|
-
* "https://appleid.apple.com", "team_id": "2EXAMPLE",
|
|
3109
|
-
* "token_request_method": "POST", "token_url":
|
|
3110
|
-
* "https://appleid.apple.com/auth/token" \}</code>
|
|
3111
|
-
* </p>
|
|
3112
|
-
* </dd>
|
|
3113
|
-
* <dt>Facebook</dt>
|
|
3114
|
-
* <dd>
|
|
3115
|
-
* <p>Create or update request: <code>"ProviderDetails": \{ "api_version": "v17.0",
|
|
3116
|
-
* "authorize_scopes": "public_profile, email", "client_id": "1example23456789",
|
|
3117
|
-
* "client_secret": "provider-app-client-secret" \}</code>
|
|
3118
|
-
* </p>
|
|
3119
|
-
* <p>Describe response: <code>"ProviderDetails":
|
|
3120
|
-
* \{ "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
|
|
3121
|
-
* "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email",
|
|
3122
|
-
* "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id":
|
|
3123
|
-
* "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method":
|
|
3124
|
-
* "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" \}</code>
|
|
3125
|
-
* </p>
|
|
3126
|
-
* </dd>
|
|
3127
|
-
* </dl>
|
|
3128
|
-
* @public
|
|
3129
|
-
*/
|
|
3130
|
-
ProviderDetails?: Record<string, string> | undefined;
|
|
3131
|
-
/**
|
|
3132
|
-
* <p>A mapping of IdP attributes to standard and custom user pool attributes. Specify a
|
|
3133
|
-
* user pool attribute as the key of the key-value pair, and the IdP attribute claim name
|
|
3134
|
-
* as the value.</p>
|
|
3135
|
-
* @public
|
|
3136
|
-
*/
|
|
3137
|
-
AttributeMapping?: Record<string, string> | undefined;
|
|
3138
|
-
/**
|
|
3139
|
-
* <p>An array of IdP identifiers, for example <code>"IdPIdentifiers": [ "MyIdP", "MyIdP2"
|
|
3140
|
-
* ]</code>. Identifiers are friendly names that you can pass in the
|
|
3141
|
-
* <code>idp_identifier</code> query parameter of requests to the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html">Authorize endpoint</a> to silently redirect to sign-in with the associated IdP.
|
|
3142
|
-
* Identifiers in a domain format also enable the use of <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html">email-address matching with SAML providers</a>. </p>
|
|
3143
|
-
* @public
|
|
3144
|
-
*/
|
|
3145
|
-
IdpIdentifiers?: string[] | undefined;
|
|
3146
|
-
}
|
|
3147
|
-
/**
|
|
3148
|
-
* @public
|
|
3149
|
-
*/
|
|
3150
|
-
export interface UpdateIdentityProviderResponse {
|
|
3151
|
-
/**
|
|
3152
|
-
* <p>The identity provider details.</p>
|
|
3153
|
-
* @public
|
|
3154
|
-
*/
|
|
3155
|
-
IdentityProvider: IdentityProviderType | undefined;
|
|
3156
|
-
}
|
|
3157
|
-
/**
|
|
3158
|
-
* @public
|
|
3159
|
-
*/
|
|
3160
|
-
export interface UpdateManagedLoginBrandingRequest {
|
|
3161
|
-
/**
|
|
3162
|
-
* <p>The ID of the user pool that contains the managed login branding style that you want
|
|
3163
|
-
* to update.</p>
|
|
3164
|
-
* @public
|
|
3165
|
-
*/
|
|
3166
|
-
UserPoolId?: string | undefined;
|
|
3167
|
-
/**
|
|
3168
|
-
* <p>The ID of the managed login branding style that you want to update.</p>
|
|
3169
|
-
* @public
|
|
3170
|
-
*/
|
|
3171
|
-
ManagedLoginBrandingId?: string | undefined;
|
|
3172
|
-
/**
|
|
3173
|
-
* <p>When <code>true</code>, applies the default branding style options. This option
|
|
3174
|
-
* reverts to default style options that are managed by Amazon Cognito. You can modify them later in
|
|
3175
|
-
* the branding editor.</p>
|
|
3176
|
-
* <p>When you specify <code>true</code> for this option, you must also omit values for
|
|
3177
|
-
* <code>Settings</code> and <code>Assets</code> in the request.</p>
|
|
3178
|
-
* @public
|
|
3179
|
-
*/
|
|
3180
|
-
UseCognitoProvidedValues?: boolean | undefined;
|
|
3181
|
-
/**
|
|
3182
|
-
* <p>A JSON file, encoded as a <code>Document</code> type, with the the settings that you
|
|
3183
|
-
* want to apply to your style.</p>
|
|
3184
|
-
* <p>The following components are not currently implemented and reserved for future
|
|
3185
|
-
* use:</p>
|
|
3186
|
-
* <ul>
|
|
3187
|
-
* <li>
|
|
3188
|
-
* <p>
|
|
3189
|
-
* <code>signUp</code>
|
|
3190
|
-
* </p>
|
|
3191
|
-
* </li>
|
|
3192
|
-
* <li>
|
|
3193
|
-
* <p>
|
|
3194
|
-
* <code>instructions</code>
|
|
3195
|
-
* </p>
|
|
3196
|
-
* </li>
|
|
3197
|
-
* <li>
|
|
3198
|
-
* <p>
|
|
3199
|
-
* <code>sessionTimerDisplay</code>
|
|
3200
|
-
* </p>
|
|
3201
|
-
* </li>
|
|
3202
|
-
* <li>
|
|
3203
|
-
* <p>
|
|
3204
|
-
* <code>languageSelector</code> (for localization, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization">Managed login localization)</a>
|
|
3205
|
-
* </p>
|
|
3206
|
-
* </li>
|
|
3207
|
-
* </ul>
|
|
3208
|
-
* @public
|
|
3209
|
-
*/
|
|
3210
|
-
Settings?: __DocumentType | undefined;
|
|
3211
|
-
/**
|
|
3212
|
-
* <p>An array of image files that you want to apply to roles like backgrounds, logos, and
|
|
3213
|
-
* icons. Each object must also indicate whether it is for dark mode, light mode, or
|
|
3214
|
-
* browser-adaptive mode.</p>
|
|
3215
|
-
* @public
|
|
3216
|
-
*/
|
|
3217
|
-
Assets?: AssetType[] | undefined;
|
|
3218
|
-
}
|
|
3219
|
-
/**
|
|
3220
|
-
* @public
|
|
3221
|
-
*/
|
|
3222
|
-
export interface UpdateManagedLoginBrandingResponse {
|
|
3223
|
-
/**
|
|
3224
|
-
* <p>The details of the branding style that you updated.</p>
|
|
3225
|
-
* @public
|
|
3226
|
-
*/
|
|
3227
|
-
ManagedLoginBranding?: ManagedLoginBrandingType | undefined;
|
|
3228
|
-
}
|
|
3229
|
-
/**
|
|
3230
|
-
* @public
|
|
3231
|
-
*/
|
|
3232
|
-
export interface UpdateResourceServerRequest {
|
|
3233
|
-
/**
|
|
3234
|
-
* <p>The ID of the user pool that contains the resource server that you want to
|
|
3235
|
-
* update.</p>
|
|
3236
|
-
* @public
|
|
3237
|
-
*/
|
|
3238
|
-
UserPoolId: string | undefined;
|
|
3239
|
-
/**
|
|
3240
|
-
* <p>A unique resource server identifier for the resource server. The identifier can be an
|
|
3241
|
-
* API friendly name like <code>solar-system-data</code>. You can also set an API URL like
|
|
3242
|
-
* <code>https://solar-system-data-api.example.com</code> as your identifier.</p>
|
|
3243
|
-
* <p>Amazon Cognito represents scopes in the access token in the format
|
|
3244
|
-
* <code>$resource-server-identifier/$scope</code>. Longer scope-identifier strings
|
|
3245
|
-
* increase the size of your access tokens.</p>
|
|
3246
|
-
* @public
|
|
3247
|
-
*/
|
|
3248
|
-
Identifier: string | undefined;
|
|
3249
|
-
/**
|
|
3250
|
-
* <p>The updated name of the resource server.</p>
|
|
3251
|
-
* @public
|
|
3252
|
-
*/
|
|
3253
|
-
Name: string | undefined;
|
|
3254
|
-
/**
|
|
3255
|
-
* <p>An array of updated custom scope names and descriptions that you want to associate
|
|
3256
|
-
* with your resource server.</p>
|
|
3257
|
-
* @public
|
|
3258
|
-
*/
|
|
3259
|
-
Scopes?: ResourceServerScopeType[] | undefined;
|
|
3260
|
-
}
|
|
3261
|
-
/**
|
|
3262
|
-
* @public
|
|
3263
|
-
*/
|
|
3264
|
-
export interface UpdateResourceServerResponse {
|
|
3265
|
-
/**
|
|
3266
|
-
* <p>The updated details of the requested resource server.</p>
|
|
3267
|
-
* @public
|
|
3268
|
-
*/
|
|
3269
|
-
ResourceServer: ResourceServerType | undefined;
|
|
3270
|
-
}
|
|
3271
|
-
/**
|
|
3272
|
-
* @public
|
|
3273
|
-
*/
|
|
3274
|
-
export interface UpdateTermsRequest {
|
|
3275
|
-
/**
|
|
3276
|
-
* <p>The ID of the terms document that you want to update.</p>
|
|
3277
|
-
* @public
|
|
3278
|
-
*/
|
|
3279
|
-
TermsId: string | undefined;
|
|
3280
|
-
/**
|
|
3281
|
-
* <p>The ID of the user pool that contains the terms that you want to update.</p>
|
|
3282
|
-
* @public
|
|
3283
|
-
*/
|
|
3284
|
-
UserPoolId: string | undefined;
|
|
3285
|
-
/**
|
|
3286
|
-
* <p>The new name that you want to apply to the requested terms documents.</p>
|
|
3287
|
-
* @public
|
|
3288
|
-
*/
|
|
3289
|
-
TermsName?: string | undefined;
|
|
3290
|
-
/**
|
|
3291
|
-
* <p>This parameter is reserved for future use and currently accepts only one value.</p>
|
|
3292
|
-
* @public
|
|
3293
|
-
*/
|
|
3294
|
-
TermsSource?: TermsSourceType | undefined;
|
|
3295
|
-
/**
|
|
3296
|
-
* <p>This parameter is reserved for future use and currently accepts only one value.</p>
|
|
3297
|
-
* @public
|
|
3298
|
-
*/
|
|
3299
|
-
Enforcement?: TermsEnforcementType | undefined;
|
|
3300
|
-
/**
|
|
3301
|
-
* <p>A map of URLs to languages. For each localized language that will view the requested
|
|
3302
|
-
* <code>TermsName</code>, assign a URL. A selection of <code>cognito:default</code>
|
|
3303
|
-
* displays for all languages that don't have a language-specific URL.</p>
|
|
3304
|
-
* <p>For example, <code>"cognito:default": "https://terms.example.com", "cognito:spanish":
|
|
3305
|
-
* "https://terms.example.com/es"</code>.</p>
|
|
3306
|
-
* @public
|
|
3307
|
-
*/
|
|
3308
|
-
Links?: Record<string, string> | undefined;
|
|
3309
|
-
}
|
|
3310
|
-
/**
|
|
3311
|
-
* @public
|
|
3312
|
-
*/
|
|
3313
|
-
export interface UpdateTermsResponse {
|
|
3314
|
-
/**
|
|
3315
|
-
* <p>A summary of the updates to your terms documents.</p>
|
|
3316
|
-
* @public
|
|
3317
|
-
*/
|
|
3318
|
-
Terms?: TermsType | undefined;
|
|
3319
|
-
}
|
|
3320
|
-
/**
|
|
3321
|
-
* <p>Represents the request to update user attributes.</p>
|
|
3322
|
-
* @public
|
|
3323
|
-
*/
|
|
3324
|
-
export interface UpdateUserAttributesRequest {
|
|
3325
|
-
/**
|
|
3326
|
-
* <p>An array of name-value pairs representing user attributes.</p>
|
|
3327
|
-
* <p>For custom attributes, you must add a <code>custom:</code> prefix to the attribute
|
|
3328
|
-
* name.</p>
|
|
3329
|
-
* <p>If you have set an attribute to require verification before Amazon Cognito updates its value,
|
|
3330
|
-
* this request doesn’t immediately update the value of that attribute. After your user
|
|
3331
|
-
* receives and responds to a verification message to verify the new value, Amazon Cognito updates
|
|
3332
|
-
* the attribute value. Your user can sign in and receive messages with the original
|
|
3333
|
-
* attribute value until they verify the new value.</p>
|
|
3334
|
-
* @public
|
|
3335
|
-
*/
|
|
3336
|
-
UserAttributes: AttributeType[] | undefined;
|
|
3337
|
-
/**
|
|
3338
|
-
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
3339
|
-
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
3340
|
-
* @public
|
|
3341
|
-
*/
|
|
3342
|
-
AccessToken: string | undefined;
|
|
3343
|
-
/**
|
|
3344
|
-
* <p>A map of custom key-value pairs that you can provide as input for any custom workflows
|
|
3345
|
-
* that this action initiates. </p>
|
|
3346
|
-
* <p>You create custom workflows by assigning Lambda functions to user pool triggers. When
|
|
3347
|
-
* you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned
|
|
3348
|
-
* to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it
|
|
3349
|
-
* passes a JSON payload, which the function receives as input. This payload contains a
|
|
3350
|
-
* <code>clientMetadata</code> attribute, which provides the data that you assigned to
|
|
3351
|
-
* the ClientMetadata parameter in your UpdateUserAttributes request. In your function code
|
|
3352
|
-
* in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow
|
|
3353
|
-
* for your specific needs.</p>
|
|
3354
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
3355
|
-
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
3356
|
-
* <note>
|
|
3357
|
-
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
3358
|
-
* following:</p>
|
|
3359
|
-
* <ul>
|
|
3360
|
-
* <li>
|
|
3361
|
-
* <p>Store the <code>ClientMetadata</code> value. This data is available only
|
|
3362
|
-
* to Lambda triggers that are assigned to a user pool to support custom
|
|
3363
|
-
* workflows. If your user pool configuration doesn't include triggers, the
|
|
3364
|
-
* <code>ClientMetadata</code> parameter serves no purpose.</p>
|
|
3365
|
-
* </li>
|
|
3366
|
-
* <li>
|
|
3367
|
-
* <p>Validate the <code>ClientMetadata</code> value.</p>
|
|
3368
|
-
* </li>
|
|
3369
|
-
* <li>
|
|
3370
|
-
* <p>Encrypt the <code>ClientMetadata</code> value. Don't send sensitive
|
|
3371
|
-
* information in this parameter.</p>
|
|
3372
|
-
* </li>
|
|
3373
|
-
* </ul>
|
|
3374
|
-
* </note>
|
|
3375
|
-
* @public
|
|
3376
|
-
*/
|
|
3377
|
-
ClientMetadata?: Record<string, string> | undefined;
|
|
3378
|
-
}
|
|
3379
|
-
/**
|
|
3380
|
-
* <p>Represents the response from the server for the request to update user
|
|
3381
|
-
* attributes.</p>
|
|
3382
|
-
* @public
|
|
3383
|
-
*/
|
|
3384
|
-
export interface UpdateUserAttributesResponse {
|
|
3385
|
-
/**
|
|
3386
|
-
* <p>When the attribute-update request includes an email address or phone number attribute,
|
|
3387
|
-
* Amazon Cognito sends a message to users with a code that confirms ownership of the new value that
|
|
3388
|
-
* they entered. The <code>CodeDeliveryDetails</code> object is information about the
|
|
3389
|
-
* delivery destination for that link or code. This behavior happens in user pools
|
|
3390
|
-
* configured to automatically verify changes to those attributes. For more information,
|
|
3391
|
-
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#verifying-when-users-change-their-email-or-phone-number">Verifying when users change their email or phone
|
|
3392
|
-
* number</a>.</p>
|
|
3393
|
-
* @public
|
|
3394
|
-
*/
|
|
3395
|
-
CodeDeliveryDetailsList?: CodeDeliveryDetailsType[] | undefined;
|
|
3396
|
-
}
|
|
3397
|
-
/**
|
|
3398
|
-
* <p>Represents the request to update the user pool.</p>
|
|
3399
|
-
* @public
|
|
3400
|
-
*/
|
|
3401
|
-
export interface UpdateUserPoolRequest {
|
|
3402
|
-
/**
|
|
3403
|
-
* <p>The ID of the user pool you want to update.</p>
|
|
3404
|
-
* @public
|
|
3405
|
-
*/
|
|
3406
|
-
UserPoolId: string | undefined;
|
|
3407
|
-
/**
|
|
3408
|
-
* <p>The password policy and sign-in policy in the user pool. The password policy sets
|
|
3409
|
-
* options like password complexity requirements and password history. The sign-in policy
|
|
3410
|
-
* sets the options available to applications in <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a>.</p>
|
|
3411
|
-
* @public
|
|
3412
|
-
*/
|
|
3413
|
-
Policies?: UserPoolPolicyType | undefined;
|
|
3414
|
-
/**
|
|
3415
|
-
* <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
|
|
3416
|
-
* pool. Before you can delete a user pool that you have protected against deletion, you
|
|
3417
|
-
* must deactivate this feature.</p>
|
|
3418
|
-
* <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request,
|
|
3419
|
-
* Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool,
|
|
3420
|
-
* send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an
|
|
3421
|
-
* <code>UpdateUserPool</code> API request.</p>
|
|
3422
|
-
* @public
|
|
3423
|
-
*/
|
|
3424
|
-
DeletionProtection?: DeletionProtectionType | undefined;
|
|
3425
|
-
/**
|
|
3426
|
-
* <p>A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible
|
|
3427
|
-
* stages of authentication operations. Triggers can modify the outcome of the operations
|
|
3428
|
-
* that invoked them.</p>
|
|
3429
|
-
* @public
|
|
3430
|
-
*/
|
|
3431
|
-
LambdaConfig?: LambdaConfigType | undefined;
|
|
3432
|
-
/**
|
|
3433
|
-
* <p>The attributes that you want your user pool to automatically verify. Possible values:
|
|
3434
|
-
* <b>email</b>, <b>phone_number</b>. For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves">Verifying contact information at sign-up</a>.</p>
|
|
3435
|
-
* @public
|
|
3436
|
-
*/
|
|
3437
|
-
AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined;
|
|
3438
|
-
/**
|
|
3439
|
-
* <p>This parameter is no longer used.</p>
|
|
3440
|
-
* @public
|
|
3441
|
-
*/
|
|
3442
|
-
SmsVerificationMessage?: string | undefined;
|
|
3443
|
-
/**
|
|
3444
|
-
* <p>This parameter is no longer used.</p>
|
|
3445
|
-
* @public
|
|
3446
|
-
*/
|
|
3447
|
-
EmailVerificationMessage?: string | undefined;
|
|
3448
|
-
/**
|
|
3449
|
-
* <p>This parameter is no longer used.</p>
|
|
3450
|
-
* @public
|
|
3451
|
-
*/
|
|
3452
|
-
EmailVerificationSubject?: string | undefined;
|
|
3453
|
-
/**
|
|
3454
|
-
* <p>The template for the verification message that your user pool delivers to users who
|
|
3455
|
-
* set an email address or phone number attribute.</p>
|
|
3456
|
-
* <p>Set the email message type that corresponds to your <code>DefaultEmailOption</code>
|
|
3457
|
-
* selection. For <code>CONFIRM_WITH_LINK</code>, specify an
|
|
3458
|
-
* <code>EmailMessageByLink</code> and leave <code>EmailMessage</code> blank. For
|
|
3459
|
-
* <code>CONFIRM_WITH_CODE</code>, specify an <code>EmailMessage</code> and leave
|
|
3460
|
-
* <code>EmailMessageByLink</code> blank. When you supply both parameters with either
|
|
3461
|
-
* choice, Amazon Cognito returns an error.</p>
|
|
3462
|
-
* @public
|
|
3463
|
-
*/
|
|
3464
|
-
VerificationMessageTemplate?: VerificationMessageTemplateType | undefined;
|
|
3465
|
-
/**
|
|
3466
|
-
* <p>The contents of the SMS message that your user pool sends to users in SMS
|
|
3467
|
-
* authentication.</p>
|
|
3468
|
-
* @public
|
|
3469
|
-
*/
|
|
3470
|
-
SmsAuthenticationMessage?: string | undefined;
|
|
3471
|
-
/**
|
|
3472
|
-
* <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>,
|
|
3473
|
-
* a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
|
|
3474
|
-
* more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates">
|
|
3475
|
-
* Verifying updates to email addresses and phone numbers</a>.</p>
|
|
3476
|
-
* @public
|
|
3477
|
-
*/
|
|
3478
|
-
UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType | undefined;
|
|
3479
|
-
/**
|
|
3480
|
-
* <p>Sets multi-factor authentication (MFA) to be on, off, or optional. When
|
|
3481
|
-
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
3482
|
-
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
3483
|
-
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
3484
|
-
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
3485
|
-
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
3486
|
-
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
3487
|
-
* API responses and in managed login for users who have chosen and configured a preferred
|
|
3488
|
-
* MFA factor.</p>
|
|
3489
|
-
* @public
|
|
3490
|
-
*/
|
|
3491
|
-
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
3492
|
-
/**
|
|
3493
|
-
* <p>The device-remembering configuration for a user pool. Device remembering or device
|
|
3494
|
-
* tracking is a "Remember me on this device" option for user pools that perform
|
|
3495
|
-
* authentication with the device key of a trusted device in the back end, instead of a
|
|
3496
|
-
* user-provided MFA code. For more information about device authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>. A null value indicates that
|
|
3497
|
-
* you have deactivated device remembering in your user pool.</p>
|
|
3498
|
-
* <note>
|
|
3499
|
-
* <p>When you provide a value for any <code>DeviceConfiguration</code> field, you
|
|
3500
|
-
* activate the Amazon Cognito device-remembering feature. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with devices</a>.</p>
|
|
3501
|
-
* </note>
|
|
3502
|
-
* @public
|
|
3503
|
-
*/
|
|
3504
|
-
DeviceConfiguration?: DeviceConfigurationType | undefined;
|
|
3505
|
-
/**
|
|
3506
|
-
* <p>The email configuration of your user pool. The email configuration type sets your
|
|
3507
|
-
* preferred sending method, Amazon Web Services Region, and sender for email invitation and verification
|
|
3508
|
-
* messages from your user pool.</p>
|
|
3509
|
-
* @public
|
|
3510
|
-
*/
|
|
3511
|
-
EmailConfiguration?: EmailConfigurationType | undefined;
|
|
3512
|
-
/**
|
|
3513
|
-
* <p>The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message
|
|
3514
|
-
* with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the
|
|
3515
|
-
* Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account. For
|
|
3516
|
-
* more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html">SMS message settings</a>.</p>
|
|
3517
|
-
* @public
|
|
3518
|
-
*/
|
|
3519
|
-
SmsConfiguration?: SmsConfigurationType | undefined;
|
|
3520
|
-
/**
|
|
3521
|
-
* <p>The tag keys and values to assign to the user pool. A tag is a label that you can use
|
|
3522
|
-
* to categorize and manage user pools in different ways, such as by purpose, owner,
|
|
3523
|
-
* environment, or other criteria.</p>
|
|
3524
|
-
* @public
|
|
3525
|
-
*/
|
|
3526
|
-
UserPoolTags?: Record<string, string> | undefined;
|
|
3527
|
-
/**
|
|
3528
|
-
* <p>The configuration for administrative creation of users. Includes the template for the
|
|
3529
|
-
* invitation message for new users, the duration of temporary passwords, and permitting
|
|
3530
|
-
* self-service sign-up.</p>
|
|
3531
|
-
* @public
|
|
3532
|
-
*/
|
|
3533
|
-
AdminCreateUserConfig?: AdminCreateUserConfigType | undefined;
|
|
3534
|
-
/**
|
|
3535
|
-
* <p>Contains settings for activation of threat protection, including the operating
|
|
3536
|
-
* mode and additional authentication types. To log user security information but take
|
|
3537
|
-
* no action, set to <code>AUDIT</code>. To configure automatic security responses to
|
|
3538
|
-
* potentially unwanted traffic to your user pool, set to <code>ENFORCED</code>.</p>
|
|
3539
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a>. To activate this setting, your user pool must be on the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html">
|
|
3540
|
-
* Plus tier</a>.</p>
|
|
3541
|
-
* @public
|
|
3542
|
-
*/
|
|
3543
|
-
UserPoolAddOns?: UserPoolAddOnsType | undefined;
|
|
3544
|
-
/**
|
|
3545
|
-
* <p>The available verified method a user can use to recover their password when they call
|
|
3546
|
-
* <code>ForgotPassword</code>. You can use this setting to define a preferred method
|
|
3547
|
-
* when a user has more than one method available. With this setting, SMS doesn't qualify
|
|
3548
|
-
* for a valid password recovery mechanism if the user also has SMS multi-factor
|
|
3549
|
-
* authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy
|
|
3550
|
-
* behavior to determine the recovery method where SMS is preferred through email.</p>
|
|
3551
|
-
* @public
|
|
3552
|
-
*/
|
|
3553
|
-
AccountRecoverySetting?: AccountRecoverySettingType | undefined;
|
|
3554
|
-
/**
|
|
3555
|
-
* <p>The updated name of your user pool.</p>
|
|
3556
|
-
* @public
|
|
3557
|
-
*/
|
|
3558
|
-
PoolName?: string | undefined;
|
|
3559
|
-
/**
|
|
3560
|
-
* <p>The user pool <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html">feature plan</a>, or tier. This parameter determines the
|
|
3561
|
-
* eligibility of the user pool for features like managed login, access-token
|
|
3562
|
-
* customization, and threat protection. Defaults to <code>ESSENTIALS</code>.</p>
|
|
3563
|
-
* @public
|
|
3564
|
-
*/
|
|
3565
|
-
UserPoolTier?: UserPoolTierType | undefined;
|
|
3566
|
-
}
|
|
3567
|
-
/**
|
|
3568
|
-
* <p>Represents the response from the server when you make a request to update the user
|
|
3569
|
-
* pool.</p>
|
|
3570
|
-
* @public
|
|
3571
|
-
*/
|
|
3572
|
-
export interface UpdateUserPoolResponse {
|
|
3573
|
-
}
|
|
3574
|
-
/**
|
|
3575
|
-
* <p>Represents the request to update the user pool client.</p>
|
|
3576
|
-
* @public
|
|
3577
|
-
*/
|
|
3578
|
-
export interface UpdateUserPoolClientRequest {
|
|
3579
|
-
/**
|
|
3580
|
-
* <p>The ID of the user pool where you want to update the app client.</p>
|
|
3581
|
-
* @public
|
|
3582
|
-
*/
|
|
3583
|
-
UserPoolId: string | undefined;
|
|
3584
|
-
/**
|
|
3585
|
-
* <p>The ID of the app client that you want to update.</p>
|
|
3586
|
-
* @public
|
|
3587
|
-
*/
|
|
3588
|
-
ClientId: string | undefined;
|
|
3589
|
-
/**
|
|
3590
|
-
* <p>A friendly name for the app client.</p>
|
|
3591
|
-
* @public
|
|
3592
|
-
*/
|
|
3593
|
-
ClientName?: string | undefined;
|
|
3594
|
-
/**
|
|
3595
|
-
* <p>The refresh token time limit. After this limit expires, your user can't use
|
|
3596
|
-
* their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
|
|
3597
|
-
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
3598
|
-
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
3599
|
-
* <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and
|
|
3600
|
-
* <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session
|
|
3601
|
-
* and retrieve new access and ID tokens for 10 days.</p>
|
|
3602
|
-
* <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days.
|
|
3603
|
-
* You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the
|
|
3604
|
-
* value with the default value of 30 days. <i>Valid range</i> is displayed below
|
|
3605
|
-
* in seconds.</p>
|
|
3606
|
-
* <p>If you don't specify otherwise in the configuration of your app client, your refresh
|
|
3607
|
-
* tokens are valid for 30 days.</p>
|
|
3608
|
-
* @public
|
|
3609
|
-
*/
|
|
3610
|
-
RefreshTokenValidity?: number | undefined;
|
|
3611
|
-
/**
|
|
3612
|
-
* <p>The access token time limit. After this limit expires, your user can't use
|
|
3613
|
-
* their access token. To specify the time unit for <code>AccessTokenValidity</code> as
|
|
3614
|
-
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
3615
|
-
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
3616
|
-
* <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and
|
|
3617
|
-
* <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with
|
|
3618
|
-
* their access token for 10 hours.</p>
|
|
3619
|
-
* <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours.
|
|
3620
|
-
* <i>Valid range</i> is displayed below in seconds.</p>
|
|
3621
|
-
* <p>If you don't specify otherwise in the configuration of your app client, your access
|
|
3622
|
-
* tokens are valid for one hour.</p>
|
|
3623
|
-
* @public
|
|
3624
|
-
*/
|
|
3625
|
-
AccessTokenValidity?: number | undefined;
|
|
3626
|
-
/**
|
|
3627
|
-
* <p>The ID token time limit. After this limit expires, your user can't use
|
|
3628
|
-
* their ID token. To specify the time unit for <code>IdTokenValidity</code> as
|
|
3629
|
-
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
3630
|
-
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
3631
|
-
* <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and
|
|
3632
|
-
* <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their
|
|
3633
|
-
* session with their ID token for 10 hours.</p>
|
|
3634
|
-
* <p>The default time unit for <code>IdTokenValidity</code> in an API request is hours.
|
|
3635
|
-
* <i>Valid range</i> is displayed below in seconds.</p>
|
|
3636
|
-
* <p>If you don't specify otherwise in the configuration of your app client, your ID
|
|
3637
|
-
* tokens are valid for one hour.</p>
|
|
3638
|
-
* @public
|
|
3639
|
-
*/
|
|
3640
|
-
IdTokenValidity?: number | undefined;
|
|
3641
|
-
/**
|
|
3642
|
-
* <p>The units that validity times are represented in. The default unit for refresh tokens
|
|
3643
|
-
* is days, and the default for ID and access tokens are hours.</p>
|
|
3644
|
-
* @public
|
|
3645
|
-
*/
|
|
3646
|
-
TokenValidityUnits?: TokenValidityUnitsType | undefined;
|
|
3647
|
-
/**
|
|
3648
|
-
* <p>The list of user attributes that you want your app client to have read access to.
|
|
3649
|
-
* After your user authenticates in your app, their access token authorizes them to read
|
|
3650
|
-
* their own attribute value for any attribute in this list.</p>
|
|
3651
|
-
* <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
|
|
3652
|
-
* app can read the values of <code>email_verified</code>,
|
|
3653
|
-
* <code>phone_number_verified</code>, and the standard attributes of your user pool.
|
|
3654
|
-
* When your user pool app client has read access to these default attributes,
|
|
3655
|
-
* <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
|
|
3656
|
-
* populates <code>ReadAttributes</code> in the API response if you have specified your own
|
|
3657
|
-
* custom set of read attributes.</p>
|
|
3658
|
-
* @public
|
|
3659
|
-
*/
|
|
3660
|
-
ReadAttributes?: string[] | undefined;
|
|
3661
|
-
/**
|
|
3662
|
-
* <p>The list of user attributes that you want your app client to have write access to.
|
|
3663
|
-
* After your user authenticates in your app, their access token authorizes them to set or
|
|
3664
|
-
* modify their own attribute value for any attribute in this list.</p>
|
|
3665
|
-
* <p>When you don't specify the <code>WriteAttributes</code> for your app client, your
|
|
3666
|
-
* app can write the values of the Standard attributes of your user pool. When your user
|
|
3667
|
-
* pool has write access to these default attributes, <code>WriteAttributes</code>
|
|
3668
|
-
* doesn't return any information. Amazon Cognito only populates
|
|
3669
|
-
* <code>WriteAttributes</code> in the API response if you have specified your own
|
|
3670
|
-
* custom set of write attributes.</p>
|
|
3671
|
-
* <p>If your app client allows users to sign in through an IdP, this array must include all
|
|
3672
|
-
* attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when
|
|
3673
|
-
* users sign in to your application through an IdP. If your app client does not have write
|
|
3674
|
-
* access to a mapped attribute, Amazon Cognito throws an error when it tries to update the
|
|
3675
|
-
* 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
|
|
3676
|
-
* pool</a>.</p>
|
|
3677
|
-
* @public
|
|
3678
|
-
*/
|
|
3679
|
-
WriteAttributes?: string[] | undefined;
|
|
3680
|
-
/**
|
|
3681
|
-
* <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
|
|
3682
|
-
* client in your user pool, you can sign in your users with any combination of one or more flows, including with
|
|
3683
|
-
* a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that
|
|
3684
|
-
* you define with Lambda functions.</p>
|
|
3685
|
-
* <note>
|
|
3686
|
-
* <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your app client supports
|
|
3687
|
-
* <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.
|
|
3688
|
-
* </p>
|
|
3689
|
-
* </note>
|
|
3690
|
-
* <p>The values for authentication flow options include the following.</p>
|
|
3691
|
-
* <ul>
|
|
3692
|
-
* <li>
|
|
3693
|
-
* <p>
|
|
3694
|
-
* <code>ALLOW_USER_AUTH</code>: Enable selection-based sign-in
|
|
3695
|
-
* with <code>USER_AUTH</code>. This setting covers username-password,
|
|
3696
|
-
* secure remote password (SRP), passwordless, and passkey authentication.
|
|
3697
|
-
* This authentiation flow can do username-password and SRP authentication
|
|
3698
|
-
* without other <code>ExplicitAuthFlows</code> permitting them. For example
|
|
3699
|
-
* users can complete an SRP challenge through <code>USER_AUTH</code>
|
|
3700
|
-
* without the flow <code>USER_SRP_AUTH</code> being active for the app
|
|
3701
|
-
* client. This flow doesn't include <code>CUSTOM_AUTH</code>.
|
|
3702
|
-
* </p>
|
|
3703
|
-
* <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">
|
|
3704
|
-
* Essentials tier</a> or higher.</p>
|
|
3705
|
-
* </li>
|
|
3706
|
-
* <li>
|
|
3707
|
-
* <p>
|
|
3708
|
-
* <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password
|
|
3709
|
-
* authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces
|
|
3710
|
-
* the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, your app
|
|
3711
|
-
* passes a user name and password to Amazon Cognito in the request, instead of using the Secure
|
|
3712
|
-
* Remote Password (SRP) protocol to securely transmit the password.</p>
|
|
3713
|
-
* </li>
|
|
3714
|
-
* <li>
|
|
3715
|
-
* <p>
|
|
3716
|
-
* <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based
|
|
3717
|
-
* authentication.</p>
|
|
3718
|
-
* </li>
|
|
3719
|
-
* <li>
|
|
3720
|
-
* <p>
|
|
3721
|
-
* <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based
|
|
3722
|
-
* authentication. In this flow, Amazon Cognito receives the password in the request instead
|
|
3723
|
-
* of using the SRP protocol to verify passwords.</p>
|
|
3724
|
-
* </li>
|
|
3725
|
-
* <li>
|
|
3726
|
-
* <p>
|
|
3727
|
-
* <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p>
|
|
3728
|
-
* </li>
|
|
3729
|
-
* <li>
|
|
3730
|
-
* <p>
|
|
3731
|
-
* <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh
|
|
3732
|
-
* tokens.</p>
|
|
3733
|
-
* </li>
|
|
3734
|
-
* </ul>
|
|
3735
|
-
* <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>.
|
|
3736
|
-
* 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>,
|
|
3737
|
-
* like <code>ALLOW_USER_SRP_AUTH</code>.</p>
|
|
3738
|
-
* @public
|
|
3739
|
-
*/
|
|
3740
|
-
ExplicitAuthFlows?: ExplicitAuthFlowsType[] | undefined;
|
|
3741
|
-
/**
|
|
3742
|
-
* <p>A list of provider names for the identity providers (IdPs) that are supported on this
|
|
3743
|
-
* client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>,
|
|
3744
|
-
* <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
|
|
3745
|
-
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
|
|
3746
|
-
* user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
|
|
3747
|
-
* <p>This parameter sets the IdPs that <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">managed
|
|
3748
|
-
* login</a> will display on the login page for your app client. The removal of
|
|
3749
|
-
* <code>COGNITO</code> from this list doesn't prevent authentication operations
|
|
3750
|
-
* for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent
|
|
3751
|
-
* 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>.
|
|
3752
|
-
* </p>
|
|
3753
|
-
* @public
|
|
3754
|
-
*/
|
|
3755
|
-
SupportedIdentityProviders?: string[] | undefined;
|
|
3756
|
-
/**
|
|
3757
|
-
* <p>A list of allowed redirect, or callback, URLs for managed login authentication. These
|
|
3758
|
-
* URLs are the paths where you want to send your users' browsers after they complete
|
|
3759
|
-
* authentication with managed login or a third-party IdP. Typically, callback URLs are the
|
|
3760
|
-
* home of an application that uses OAuth or OIDC libraries to process authentication
|
|
3761
|
-
* outcomes.</p>
|
|
3762
|
-
* <p>A redirect URI must meet the following requirements:</p>
|
|
3763
|
-
* <ul>
|
|
3764
|
-
* <li>
|
|
3765
|
-
* <p>Be an absolute URI.</p>
|
|
3766
|
-
* </li>
|
|
3767
|
-
* <li>
|
|
3768
|
-
* <p>Be registered with the authorization server. Amazon Cognito doesn't accept
|
|
3769
|
-
* authorization requests with <code>redirect_uri</code> values that aren't in
|
|
3770
|
-
* the list of <code>CallbackURLs</code> that you provide in this parameter.</p>
|
|
3771
|
-
* </li>
|
|
3772
|
-
* <li>
|
|
3773
|
-
* <p>Not include a fragment component.</p>
|
|
3774
|
-
* </li>
|
|
3775
|
-
* </ul>
|
|
3776
|
-
* <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 -
|
|
3777
|
-
* Redirection Endpoint</a>.</p>
|
|
3778
|
-
* <p>Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes
|
|
3779
|
-
* only.</p>
|
|
3780
|
-
* <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
|
|
3781
|
-
* @public
|
|
3782
|
-
*/
|
|
3783
|
-
CallbackURLs?: string[] | undefined;
|
|
3784
|
-
/**
|
|
3785
|
-
* <p>A list of allowed logout URLs for managed login authentication. When you pass
|
|
3786
|
-
* <code>logout_uri</code> and <code>client_id</code> parameters to
|
|
3787
|
-
* <code>/logout</code>, Amazon Cognito signs out your user and redirects them to the logout
|
|
3788
|
-
* URL. This parameter describes the URLs that you want to be the permitted targets of
|
|
3789
|
-
* <code>logout_uri</code>. A typical use of these URLs is when a user selects "Sign
|
|
3790
|
-
* 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
|
|
3791
|
-
* endpoint</a>.</p>
|
|
3792
|
-
* @public
|
|
3793
|
-
*/
|
|
3794
|
-
LogoutURLs?: string[] | undefined;
|
|
3795
|
-
/**
|
|
3796
|
-
* <p>The default redirect URI. In app clients with one assigned IdP, replaces
|
|
3797
|
-
* <code>redirect_uri</code> in authentication requests. Must be in the
|
|
3798
|
-
* <code>CallbackURLs</code> list.</p>
|
|
3799
|
-
* @public
|
|
3800
|
-
*/
|
|
3801
|
-
DefaultRedirectURI?: string | undefined;
|
|
3802
|
-
/**
|
|
3803
|
-
* <p>The OAuth grant types that you want your app client to generate. To create an app
|
|
3804
|
-
* client that generates client credentials grants, you must add
|
|
3805
|
-
* <code>client_credentials</code> as the only allowed OAuth flow.</p>
|
|
3806
|
-
* <dl>
|
|
3807
|
-
* <dt>code</dt>
|
|
3808
|
-
* <dd>
|
|
3809
|
-
* <p>Use a code grant flow, which provides an authorization code as the
|
|
3810
|
-
* response. This code can be exchanged for access tokens with the
|
|
3811
|
-
* <code>/oauth2/token</code> endpoint.</p>
|
|
3812
|
-
* </dd>
|
|
3813
|
-
* <dt>implicit</dt>
|
|
3814
|
-
* <dd>
|
|
3815
|
-
* <p>Issue the access token (and, optionally, ID token, based on scopes)
|
|
3816
|
-
* directly to your user.</p>
|
|
3817
|
-
* </dd>
|
|
3818
|
-
* <dt>client_credentials</dt>
|
|
3819
|
-
* <dd>
|
|
3820
|
-
* <p>Issue the access token from the <code>/oauth2/token</code> endpoint
|
|
3821
|
-
* directly to a non-person user using a combination of the client ID and
|
|
3822
|
-
* client secret.</p>
|
|
3823
|
-
* </dd>
|
|
3824
|
-
* </dl>
|
|
3825
|
-
* @public
|
|
3826
|
-
*/
|
|
3827
|
-
AllowedOAuthFlows?: OAuthFlowType[] | undefined;
|
|
3828
|
-
/**
|
|
3829
|
-
* <p>The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app
|
|
3830
|
-
* client to authorize access with. Scopes govern access control to user pool self-service
|
|
3831
|
-
* API operations, user data from the <code>userInfo</code> endpoint, and third-party APIs.
|
|
3832
|
-
* Scope values include <code>phone</code>, <code>email</code>, <code>openid</code>, and
|
|
3833
|
-
* <code>profile</code>. The <code>aws.cognito.signin.user.admin</code> scope
|
|
3834
|
-
* authorizes user self-service operations. Custom scopes with resource servers authorize
|
|
3835
|
-
* access to external APIs.</p>
|
|
3836
|
-
* @public
|
|
3837
|
-
*/
|
|
3838
|
-
AllowedOAuthScopes?: string[] | undefined;
|
|
3839
|
-
/**
|
|
3840
|
-
* <p>Set to <code>true</code> to use OAuth 2.0 authorization server features in your app client.</p>
|
|
3841
|
-
* <p>This parameter must have a value of <code>true</code> before you can configure
|
|
3842
|
-
* the following features in your app client.</p>
|
|
3843
|
-
* <ul>
|
|
3844
|
-
* <li>
|
|
3845
|
-
* <p>
|
|
3846
|
-
* <code>CallBackURLs</code>: Callback URLs.</p>
|
|
3847
|
-
* </li>
|
|
3848
|
-
* <li>
|
|
3849
|
-
* <p>
|
|
3850
|
-
* <code>LogoutURLs</code>: Sign-out redirect URLs.</p>
|
|
3851
|
-
* </li>
|
|
3852
|
-
* <li>
|
|
3853
|
-
* <p>
|
|
3854
|
-
* <code>AllowedOAuthScopes</code>: OAuth 2.0 scopes.</p>
|
|
3855
|
-
* </li>
|
|
3856
|
-
* <li>
|
|
3857
|
-
* <p>
|
|
3858
|
-
* <code>AllowedOAuthFlows</code>: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.</p>
|
|
3859
|
-
* </li>
|
|
3860
|
-
* </ul>
|
|
3861
|
-
* <p>To use authorization server features, configure one of these features in the Amazon Cognito console or set
|
|
3862
|
-
* <code>AllowedOAuthFlowsUserPoolClient</code> to <code>true</code> in a <code>CreateUserPoolClient</code> or
|
|
3863
|
-
* <code>UpdateUserPoolClient</code> API request. If you don't set a value for
|
|
3864
|
-
* <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
|
|
3865
|
-
* to <code>false</code>. When <code>false</code>, only SDK-based API sign-in is permitted.</p>
|
|
3866
|
-
* @public
|
|
3867
|
-
*/
|
|
3868
|
-
AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
|
|
3869
|
-
/**
|
|
3870
|
-
* <p>The user pool analytics configuration for collecting metrics and sending them to your
|
|
3871
|
-
* Amazon Pinpoint campaign.</p>
|
|
3872
|
-
* <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools might not have access to
|
|
3873
|
-
* analytics or might be configurable with campaigns in the US East (N. Virginia) Region.
|
|
3874
|
-
* 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>
|
|
3875
|
-
* @public
|
|
3876
|
-
*/
|
|
3877
|
-
AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
|
|
3878
|
-
/**
|
|
3879
|
-
* <p>When <code>ENABLED</code>, suppresses messages that might indicate a valid user exists
|
|
3880
|
-
* when someone attempts sign-in. This parameters sets your preference for the errors and
|
|
3881
|
-
* responses that you want Amazon Cognito APIs to return during authentication, account
|
|
3882
|
-
* confirmation, and password recovery when the user doesn't exist in the user pool. When
|
|
3883
|
-
* set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error
|
|
3884
|
-
* indicating either the username or password was incorrect. Account confirmation and
|
|
3885
|
-
* password recovery return a response indicating a code was sent to a simulated
|
|
3886
|
-
* destination. When set to <code>LEGACY</code>, those APIs return a
|
|
3887
|
-
* <code>UserNotFoundException</code> exception if the user doesn't exist in the user
|
|
3888
|
-
* pool.</p>
|
|
3889
|
-
* <p>Defaults to <code>LEGACY</code>.</p>
|
|
3890
|
-
* @public
|
|
3891
|
-
*/
|
|
3892
|
-
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
|
|
3893
|
-
/**
|
|
3894
|
-
* <p>Activates or deactivates <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html">token
|
|
3895
|
-
* revocation</a> in the target app client.</p>
|
|
3896
|
-
* @public
|
|
3897
|
-
*/
|
|
3898
|
-
EnableTokenRevocation?: boolean | undefined;
|
|
3899
|
-
/**
|
|
3900
|
-
* <p>When <code>true</code>, your application can include additional
|
|
3901
|
-
* <code>UserContextData</code> in authentication requests. This data includes the IP
|
|
3902
|
-
* address, and contributes to analysis by threat protection features. For more information
|
|
3903
|
-
* 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,
|
|
3904
|
-
* you can't send the source IP address to Amazon Cognito threat protection features. You can only
|
|
3905
|
-
* activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has
|
|
3906
|
-
* a client secret.</p>
|
|
3907
|
-
* @public
|
|
3908
|
-
*/
|
|
3909
|
-
EnablePropagateAdditionalUserContextData?: boolean | undefined;
|
|
3910
|
-
/**
|
|
3911
|
-
* <p>Amazon Cognito creates a session token for each API request in an authentication flow. <code>AuthSessionValidity</code> is the duration,
|
|
3912
|
-
* in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.</p>
|
|
3913
|
-
* @public
|
|
3914
|
-
*/
|
|
3915
|
-
AuthSessionValidity?: number | undefined;
|
|
3916
|
-
/**
|
|
3917
|
-
* <p>The configuration of your app client for refresh token rotation. When enabled, your
|
|
3918
|
-
* app client issues new ID, access, and refresh tokens when users renew their sessions
|
|
3919
|
-
* with refresh tokens. When disabled, token refresh issues only ID and access
|
|
3920
|
-
* tokens.</p>
|
|
3921
|
-
* @public
|
|
3922
|
-
*/
|
|
3923
|
-
RefreshTokenRotation?: RefreshTokenRotationType | undefined;
|
|
3924
|
-
}
|
|
1
|
+
import { VerifySoftwareTokenResponseType } from "./enums";
|
|
2
|
+
import { CustomDomainConfigType, UserPoolClientType } from "./models_0";
|
|
3925
3
|
/**
|
|
3926
4
|
* <p>Represents the response from the server to the request to update the user pool
|
|
3927
5
|
* client.</p>
|
|
@@ -3993,19 +71,6 @@ export interface UpdateUserPoolDomainResponse {
|
|
|
3993
71
|
*/
|
|
3994
72
|
CloudFrontDomain?: string | undefined;
|
|
3995
73
|
}
|
|
3996
|
-
/**
|
|
3997
|
-
* <p>This exception is thrown when there is a code mismatch and the service fails to
|
|
3998
|
-
* configure the software token TOTP multi-factor authentication (MFA).</p>
|
|
3999
|
-
* @public
|
|
4000
|
-
*/
|
|
4001
|
-
export declare class EnableSoftwareTokenMFAException extends __BaseException {
|
|
4002
|
-
readonly name: "EnableSoftwareTokenMFAException";
|
|
4003
|
-
readonly $fault: "client";
|
|
4004
|
-
/**
|
|
4005
|
-
* @internal
|
|
4006
|
-
*/
|
|
4007
|
-
constructor(opts: __ExceptionOptionType<EnableSoftwareTokenMFAException, __BaseException>);
|
|
4008
|
-
}
|
|
4009
74
|
/**
|
|
4010
75
|
* @public
|
|
4011
76
|
*/
|
|
@@ -4032,18 +97,6 @@ export interface VerifySoftwareTokenRequest {
|
|
|
4032
97
|
*/
|
|
4033
98
|
FriendlyDeviceName?: string | undefined;
|
|
4034
99
|
}
|
|
4035
|
-
/**
|
|
4036
|
-
* @public
|
|
4037
|
-
* @enum
|
|
4038
|
-
*/
|
|
4039
|
-
export declare const VerifySoftwareTokenResponseType: {
|
|
4040
|
-
readonly ERROR: "ERROR";
|
|
4041
|
-
readonly SUCCESS: "SUCCESS";
|
|
4042
|
-
};
|
|
4043
|
-
/**
|
|
4044
|
-
* @public
|
|
4045
|
-
*/
|
|
4046
|
-
export type VerifySoftwareTokenResponseType = (typeof VerifySoftwareTokenResponseType)[keyof typeof VerifySoftwareTokenResponseType];
|
|
4047
100
|
/**
|
|
4048
101
|
* @public
|
|
4049
102
|
*/
|