@aws-sdk/client-cognito-identity-provider 3.696.0 → 3.708.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/README.md +80 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +20 -0
- package/dist-cjs/index.js +983 -71
- package/dist-es/CognitoIdentityProvider.js +20 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +20 -0
- package/dist-es/commands/CompleteWebAuthnRegistrationCommand.js +23 -0
- package/dist-es/commands/ConfirmSignUpCommand.js +2 -2
- package/dist-es/commands/CreateManagedLoginBrandingCommand.js +23 -0
- package/dist-es/commands/DeleteManagedLoginBrandingCommand.js +22 -0
- package/dist-es/commands/DeleteWebAuthnCredentialCommand.js +23 -0
- package/dist-es/commands/DescribeManagedLoginBrandingByClientCommand.js +23 -0
- package/dist-es/commands/DescribeManagedLoginBrandingCommand.js +22 -0
- package/dist-es/commands/GetUserAuthFactorsCommand.js +23 -0
- package/dist-es/commands/GlobalSignOutCommand.js +1 -1
- package/dist-es/commands/InitiateAuthCommand.js +1 -1
- package/dist-es/commands/ListDevicesCommand.js +1 -1
- package/dist-es/commands/ListUserPoolClientsCommand.js +1 -1
- package/dist-es/commands/ListUsersCommand.js +1 -1
- package/dist-es/commands/ListUsersInGroupCommand.js +1 -1
- package/dist-es/commands/ListWebAuthnCredentialsCommand.js +23 -0
- package/dist-es/commands/ResendConfirmationCodeCommand.js +1 -1
- package/dist-es/commands/RespondToAuthChallengeCommand.js +1 -2
- package/dist-es/commands/SignUpCommand.js +2 -2
- package/dist-es/commands/StartWebAuthnRegistrationCommand.js +23 -0
- package/dist-es/commands/UpdateManagedLoginBrandingCommand.js +22 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/models/models_0.js +184 -50
- package/dist-es/models/models_1.js +82 -1
- package/dist-es/protocols/Aws_json1_1.js +433 -2
- package/dist-types/CognitoIdentityProvider.d.ts +71 -0
- package/dist-types/CognitoIdentityProviderClient.d.ts +12 -2
- package/dist-types/commands/AdminCreateUserCommand.d.ts +9 -4
- package/dist-types/commands/AdminGetUserCommand.d.ts +2 -1
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +5 -4
- package/dist-types/commands/AdminListDevicesCommand.d.ts +1 -1
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +2 -2
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +4 -4
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +2 -2
- package/dist-types/commands/ChangePasswordCommand.d.ts +1 -1
- package/dist-types/commands/CompleteWebAuthnRegistrationCommand.d.ts +119 -0
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +5 -2
- package/dist-types/commands/CreateManagedLoginBrandingCommand.d.ts +162 -0
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserPoolCommand.d.ts +22 -2
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +8 -1
- package/dist-types/commands/DeleteManagedLoginBrandingCommand.d.ts +113 -0
- package/dist-types/commands/DeleteWebAuthnCredentialCommand.d.ts +90 -0
- package/dist-types/commands/DescribeManagedLoginBrandingByClientCommand.d.ts +108 -0
- package/dist-types/commands/DescribeManagedLoginBrandingCommand.d.ts +108 -0
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +6 -0
- package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +1 -0
- package/dist-types/commands/ForgotPasswordCommand.d.ts +2 -2
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +2 -2
- package/dist-types/commands/GetUserAuthFactorsCommand.d.ts +120 -0
- package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +6 -1
- package/dist-types/commands/GlobalSignOutCommand.d.ts +1 -1
- package/dist-types/commands/InitiateAuthCommand.d.ts +9 -5
- 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/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 +100 -0
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +3 -3
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +5 -6
- package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +15 -3
- package/dist-types/commands/SignUpCommand.d.ts +11 -3
- package/dist-types/commands/StartWebAuthnRegistrationCommand.d.ts +107 -0
- package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +150 -0
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +2 -2
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +17 -2
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +6 -0
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +1609 -1660
- package/dist-types/models/models_1.d.ts +1712 -8
- package/dist-types/protocols/Aws_json1_1.d.ts +90 -0
- package/dist-types/ts3.4/CognitoIdentityProvider.d.ts +177 -0
- package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +60 -0
- package/dist-types/ts3.4/commands/CompleteWebAuthnRegistrationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ConfirmSignUpCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateManagedLoginBrandingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteManagedLoginBrandingCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteWebAuthnCredentialCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeManagedLoginBrandingByClientCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeManagedLoginBrandingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetUserAuthFactorsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetUserPoolMfaConfigCommand.d.ts +2 -4
- 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/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 +51 -0
- package/dist-types/ts3.4/commands/ResendConfirmationCodeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RespondToAuthChallengeCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/StartWebAuthnRegistrationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateManagedLoginBrandingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +248 -185
- package/dist-types/ts3.4/models/models_1.d.ts +263 -2
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +120 -0
- package/package.json +4 -4
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
+
import { DescribeManagedLoginBrandingRequest, DescribeManagedLoginBrandingResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeManagedLoginBrandingCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeManagedLoginBrandingCommandInput extends DescribeManagedLoginBrandingRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeManagedLoginBrandingCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeManagedLoginBrandingCommandOutput extends DescribeManagedLoginBrandingResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeManagedLoginBrandingCommand_base: {
|
|
25
|
+
new (input: DescribeManagedLoginBrandingCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeManagedLoginBrandingCommandInput, DescribeManagedLoginBrandingCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DescribeManagedLoginBrandingCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeManagedLoginBrandingCommandInput, DescribeManagedLoginBrandingCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>When given the ID of a managed login branding style, returns detailed information
|
|
31
|
+
* about the style.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { CognitoIdentityProviderClient, DescribeManagedLoginBrandingCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
36
|
+
* // const { CognitoIdentityProviderClient, DescribeManagedLoginBrandingCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
37
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
38
|
+
* const input = { // DescribeManagedLoginBrandingRequest
|
|
39
|
+
* UserPoolId: "STRING_VALUE", // required
|
|
40
|
+
* ManagedLoginBrandingId: "STRING_VALUE", // required
|
|
41
|
+
* ReturnMergedResources: true || false,
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DescribeManagedLoginBrandingCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // DescribeManagedLoginBrandingResponse
|
|
46
|
+
* // ManagedLoginBranding: { // ManagedLoginBrandingType
|
|
47
|
+
* // ManagedLoginBrandingId: "STRING_VALUE",
|
|
48
|
+
* // UserPoolId: "STRING_VALUE",
|
|
49
|
+
* // UseCognitoProvidedValues: true || false,
|
|
50
|
+
* // Settings: "DOCUMENT_VALUE",
|
|
51
|
+
* // Assets: [ // AssetListType
|
|
52
|
+
* // { // AssetType
|
|
53
|
+
* // Category: "FAVICON_ICO" || "FAVICON_SVG" || "EMAIL_GRAPHIC" || "SMS_GRAPHIC" || "AUTH_APP_GRAPHIC" || "PASSWORD_GRAPHIC" || "PASSKEY_GRAPHIC" || "PAGE_HEADER_LOGO" || "PAGE_HEADER_BACKGROUND" || "PAGE_FOOTER_LOGO" || "PAGE_FOOTER_BACKGROUND" || "PAGE_BACKGROUND" || "FORM_BACKGROUND" || "FORM_LOGO" || "IDP_BUTTON_ICON", // required
|
|
54
|
+
* // ColorMode: "LIGHT" || "DARK" || "DYNAMIC", // required
|
|
55
|
+
* // Extension: "ICO" || "JPEG" || "PNG" || "SVG" || "WEBP", // required
|
|
56
|
+
* // Bytes: new Uint8Array(),
|
|
57
|
+
* // ResourceId: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // CreationDate: new Date("TIMESTAMP"),
|
|
61
|
+
* // LastModifiedDate: new Date("TIMESTAMP"),
|
|
62
|
+
* // },
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param DescribeManagedLoginBrandingCommandInput - {@link DescribeManagedLoginBrandingCommandInput}
|
|
68
|
+
* @returns {@link DescribeManagedLoginBrandingCommandOutput}
|
|
69
|
+
* @see {@link DescribeManagedLoginBrandingCommandInput} for command's `input` shape.
|
|
70
|
+
* @see {@link DescribeManagedLoginBrandingCommandOutput} for command's `response` shape.
|
|
71
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
74
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
77
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
78
|
+
* parameter.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
81
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
|
|
85
|
+
* resource.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
88
|
+
* <p>This exception is thrown when the user has made too many requests for a given
|
|
89
|
+
* operation.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
93
|
+
*
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class DescribeManagedLoginBrandingCommand extends DescribeManagedLoginBrandingCommand_base {
|
|
97
|
+
/** @internal type navigation helper, not in runtime. */
|
|
98
|
+
protected static __types: {
|
|
99
|
+
api: {
|
|
100
|
+
input: DescribeManagedLoginBrandingRequest;
|
|
101
|
+
output: DescribeManagedLoginBrandingResponse;
|
|
102
|
+
};
|
|
103
|
+
sdk: {
|
|
104
|
+
input: DescribeManagedLoginBrandingCommandInput;
|
|
105
|
+
output: DescribeManagedLoginBrandingCommandOutput;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
}
|
|
@@ -84,7 +84,7 @@ declare const DescribeUserPoolClientCommand_base: {
|
|
|
84
84
|
* // "STRING_VALUE",
|
|
85
85
|
* // ],
|
|
86
86
|
* // ExplicitAuthFlows: [ // ExplicitAuthFlowsListType
|
|
87
|
-
* // "ADMIN_NO_SRP_AUTH" || "CUSTOM_AUTH_FLOW_ONLY" || "USER_PASSWORD_AUTH" || "ALLOW_ADMIN_USER_PASSWORD_AUTH" || "ALLOW_CUSTOM_AUTH" || "ALLOW_USER_PASSWORD_AUTH" || "ALLOW_USER_SRP_AUTH" || "ALLOW_REFRESH_TOKEN_AUTH",
|
|
87
|
+
* // "ADMIN_NO_SRP_AUTH" || "CUSTOM_AUTH_FLOW_ONLY" || "USER_PASSWORD_AUTH" || "ALLOW_ADMIN_USER_PASSWORD_AUTH" || "ALLOW_CUSTOM_AUTH" || "ALLOW_USER_PASSWORD_AUTH" || "ALLOW_USER_SRP_AUTH" || "ALLOW_REFRESH_TOKEN_AUTH" || "ALLOW_USER_AUTH",
|
|
88
88
|
* // ],
|
|
89
89
|
* // SupportedIdentityProviders: [ // SupportedIdentityProvidersListType
|
|
90
90
|
* // "STRING_VALUE",
|
|
@@ -73,6 +73,11 @@ declare const DescribeUserPoolCommand_base: {
|
|
|
73
73
|
* // PasswordHistorySize: Number("int"),
|
|
74
74
|
* // TemporaryPasswordValidityDays: Number("int"),
|
|
75
75
|
* // },
|
|
76
|
+
* // SignInPolicy: { // SignInPolicyType
|
|
77
|
+
* // AllowedFirstAuthFactors: [ // AllowedFirstAuthFactorsListType
|
|
78
|
+
* // "PASSWORD" || "EMAIL_OTP" || "SMS_OTP" || "WEB_AUTHN",
|
|
79
|
+
* // ],
|
|
80
|
+
* // },
|
|
76
81
|
* // },
|
|
77
82
|
* // DeletionProtection: "ACTIVE" || "INACTIVE",
|
|
78
83
|
* // LambdaConfig: { // LambdaConfigType
|
|
@@ -198,6 +203,7 @@ declare const DescribeUserPoolCommand_base: {
|
|
|
198
203
|
* // },
|
|
199
204
|
* // ],
|
|
200
205
|
* // },
|
|
206
|
+
* // UserPoolTier: "LITE" || "ESSENTIALS" || "PLUS",
|
|
201
207
|
* // },
|
|
202
208
|
* // };
|
|
203
209
|
*
|
|
@@ -53,7 +53,7 @@ declare const ForgotPasswordCommand_base: {
|
|
|
53
53
|
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
54
54
|
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
55
55
|
* in.</p>
|
|
56
|
-
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web
|
|
56
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,
|
|
57
57
|
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
58
58
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
59
59
|
* mode</a>
|
|
@@ -130,7 +130,7 @@ declare const ForgotPasswordCommand_base: {
|
|
|
130
130
|
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
|
|
131
131
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
132
132
|
* provided for SMS configuration. This can happen if you don't trust
|
|
133
|
-
*
|
|
133
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
134
134
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
135
135
|
*
|
|
136
136
|
* @throws {@link LimitExceededException} (client fault)
|
|
@@ -45,7 +45,7 @@ declare const GetUserAttributeVerificationCodeCommand_base: {
|
|
|
45
45
|
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
46
46
|
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
47
47
|
* in.</p>
|
|
48
|
-
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web
|
|
48
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,
|
|
49
49
|
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
50
50
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
51
51
|
* mode</a>
|
|
@@ -114,7 +114,7 @@ declare const GetUserAttributeVerificationCodeCommand_base: {
|
|
|
114
114
|
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
|
|
115
115
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
116
116
|
* provided for SMS configuration. This can happen if you don't trust
|
|
117
|
-
*
|
|
117
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
118
118
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
119
119
|
*
|
|
120
120
|
* @throws {@link LimitExceededException} (client fault)
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
+
import { GetUserAuthFactorsRequest, GetUserAuthFactorsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetUserAuthFactorsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetUserAuthFactorsCommandInput extends GetUserAuthFactorsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetUserAuthFactorsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetUserAuthFactorsCommandOutput extends GetUserAuthFactorsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetUserAuthFactorsCommand_base: {
|
|
25
|
+
new (input: GetUserAuthFactorsCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserAuthFactorsCommandInput, GetUserAuthFactorsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetUserAuthFactorsCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserAuthFactorsCommandInput, GetUserAuthFactorsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists the authentication options for the currently signed-in user. Returns the
|
|
31
|
+
* following:</p>
|
|
32
|
+
* <ol>
|
|
33
|
+
* <li>
|
|
34
|
+
* <p>The user's multi-factor authentication (MFA) preferences.</p>
|
|
35
|
+
* </li>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>The user's options in the <code>USER_AUTH</code> flow that they can
|
|
38
|
+
* select in a <code>SELECT_CHALLENGE</code> response or request in a
|
|
39
|
+
* <code>PREFERRED_CHALLENGE</code>request.</p>
|
|
40
|
+
* </li>
|
|
41
|
+
* </ol>
|
|
42
|
+
* @example
|
|
43
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
44
|
+
* ```javascript
|
|
45
|
+
* import { CognitoIdentityProviderClient, GetUserAuthFactorsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
46
|
+
* // const { CognitoIdentityProviderClient, GetUserAuthFactorsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
47
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
48
|
+
* const input = { // GetUserAuthFactorsRequest
|
|
49
|
+
* AccessToken: "STRING_VALUE", // required
|
|
50
|
+
* };
|
|
51
|
+
* const command = new GetUserAuthFactorsCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* // { // GetUserAuthFactorsResponse
|
|
54
|
+
* // Username: "STRING_VALUE", // required
|
|
55
|
+
* // PreferredMfaSetting: "STRING_VALUE",
|
|
56
|
+
* // UserMFASettingList: [ // UserMFASettingListType
|
|
57
|
+
* // "STRING_VALUE",
|
|
58
|
+
* // ],
|
|
59
|
+
* // ConfiguredUserAuthFactors: [ // ConfiguredUserAuthFactorsListType
|
|
60
|
+
* // "PASSWORD" || "EMAIL_OTP" || "SMS_OTP" || "WEB_AUTHN",
|
|
61
|
+
* // ],
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param GetUserAuthFactorsCommandInput - {@link GetUserAuthFactorsCommandInput}
|
|
67
|
+
* @returns {@link GetUserAuthFactorsCommandOutput}
|
|
68
|
+
* @see {@link GetUserAuthFactorsCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link GetUserAuthFactorsCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
73
|
+
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
74
|
+
* ACL that's associated with your user pool.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
77
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
80
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
81
|
+
* parameter.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
84
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link PasswordResetRequiredException} (client fault)
|
|
87
|
+
* <p>This exception is thrown when a password reset is required.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
90
|
+
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
|
|
91
|
+
* resource.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
94
|
+
* <p>This exception is thrown when the user has made too many requests for a given
|
|
95
|
+
* operation.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link UserNotConfirmedException} (client fault)
|
|
98
|
+
* <p>This exception is thrown when a user isn't confirmed successfully.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link UserNotFoundException} (client fault)
|
|
101
|
+
* <p>This exception is thrown when a user isn't found.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
104
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
105
|
+
*
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
export declare class GetUserAuthFactorsCommand extends GetUserAuthFactorsCommand_base {
|
|
109
|
+
/** @internal type navigation helper, not in runtime. */
|
|
110
|
+
protected static __types: {
|
|
111
|
+
api: {
|
|
112
|
+
input: GetUserAuthFactorsRequest;
|
|
113
|
+
output: GetUserAuthFactorsResponse;
|
|
114
|
+
};
|
|
115
|
+
sdk: {
|
|
116
|
+
input: GetUserAuthFactorsCommandInput;
|
|
117
|
+
output: GetUserAuthFactorsCommandOutput;
|
|
118
|
+
};
|
|
119
|
+
};
|
|
120
|
+
}
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { GetUserPoolMfaConfigRequest
|
|
4
|
+
import { GetUserPoolMfaConfigRequest } from "../models/models_0";
|
|
5
|
+
import { GetUserPoolMfaConfigResponse } from "../models/models_1";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -56,6 +57,10 @@ declare const GetUserPoolMfaConfigCommand_base: {
|
|
|
56
57
|
* // Subject: "STRING_VALUE",
|
|
57
58
|
* // },
|
|
58
59
|
* // MfaConfiguration: "OFF" || "ON" || "OPTIONAL",
|
|
60
|
+
* // WebAuthnConfiguration: { // WebAuthnConfigurationType
|
|
61
|
+
* // RelyingPartyId: "STRING_VALUE",
|
|
62
|
+
* // UserVerification: "required" || "preferred",
|
|
63
|
+
* // },
|
|
59
64
|
* // };
|
|
60
65
|
*
|
|
61
66
|
* ```
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { GlobalSignOutRequest, GlobalSignOutResponse } from "../models/
|
|
4
|
+
import { GlobalSignOutRequest, GlobalSignOutResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { InitiateAuthRequest, InitiateAuthResponse } from "../models/
|
|
4
|
+
import { InitiateAuthRequest, InitiateAuthResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -43,7 +43,7 @@ declare const InitiateAuthCommand_base: {
|
|
|
43
43
|
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
44
44
|
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
45
45
|
* in.</p>
|
|
46
|
-
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web
|
|
46
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,
|
|
47
47
|
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
48
48
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
49
49
|
* mode</a>
|
|
@@ -59,7 +59,7 @@ declare const InitiateAuthCommand_base: {
|
|
|
59
59
|
* // const { CognitoIdentityProviderClient, InitiateAuthCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
60
60
|
* const client = new CognitoIdentityProviderClient(config);
|
|
61
61
|
* const input = { // InitiateAuthRequest
|
|
62
|
-
* AuthFlow: "USER_SRP_AUTH" || "REFRESH_TOKEN_AUTH" || "REFRESH_TOKEN" || "CUSTOM_AUTH" || "ADMIN_NO_SRP_AUTH" || "USER_PASSWORD_AUTH" || "ADMIN_USER_PASSWORD_AUTH", // required
|
|
62
|
+
* AuthFlow: "USER_SRP_AUTH" || "REFRESH_TOKEN_AUTH" || "REFRESH_TOKEN" || "CUSTOM_AUTH" || "ADMIN_NO_SRP_AUTH" || "USER_PASSWORD_AUTH" || "ADMIN_USER_PASSWORD_AUTH" || "USER_AUTH", // required
|
|
63
63
|
* AuthParameters: { // AuthParametersType
|
|
64
64
|
* "<keys>": "STRING_VALUE",
|
|
65
65
|
* },
|
|
@@ -74,11 +74,12 @@ declare const InitiateAuthCommand_base: {
|
|
|
74
74
|
* IpAddress: "STRING_VALUE",
|
|
75
75
|
* EncodedData: "STRING_VALUE",
|
|
76
76
|
* },
|
|
77
|
+
* Session: "STRING_VALUE",
|
|
77
78
|
* };
|
|
78
79
|
* const command = new InitiateAuthCommand(input);
|
|
79
80
|
* const response = await client.send(command);
|
|
80
81
|
* // { // InitiateAuthResponse
|
|
81
|
-
* // ChallengeName: "SMS_MFA" || "EMAIL_OTP" || "SOFTWARE_TOKEN_MFA" || "SELECT_MFA_TYPE" || "MFA_SETUP" || "PASSWORD_VERIFIER" || "CUSTOM_CHALLENGE" || "DEVICE_SRP_AUTH" || "DEVICE_PASSWORD_VERIFIER" || "ADMIN_NO_SRP_AUTH" || "NEW_PASSWORD_REQUIRED",
|
|
82
|
+
* // ChallengeName: "SMS_MFA" || "EMAIL_OTP" || "SOFTWARE_TOKEN_MFA" || "SELECT_MFA_TYPE" || "MFA_SETUP" || "PASSWORD_VERIFIER" || "CUSTOM_CHALLENGE" || "SELECT_CHALLENGE" || "DEVICE_SRP_AUTH" || "DEVICE_PASSWORD_VERIFIER" || "ADMIN_NO_SRP_AUTH" || "NEW_PASSWORD_REQUIRED" || "SMS_OTP" || "PASSWORD" || "WEB_AUTHN" || "PASSWORD_SRP",
|
|
82
83
|
* // Session: "STRING_VALUE",
|
|
83
84
|
* // ChallengeParameters: { // ChallengeParametersType
|
|
84
85
|
* // "<keys>": "STRING_VALUE",
|
|
@@ -94,6 +95,9 @@ declare const InitiateAuthCommand_base: {
|
|
|
94
95
|
* // DeviceGroupKey: "STRING_VALUE",
|
|
95
96
|
* // },
|
|
96
97
|
* // },
|
|
98
|
+
* // AvailableChallenges: [ // AvailableChallengeListType
|
|
99
|
+
* // "SMS_MFA" || "EMAIL_OTP" || "SOFTWARE_TOKEN_MFA" || "SELECT_MFA_TYPE" || "MFA_SETUP" || "PASSWORD_VERIFIER" || "CUSTOM_CHALLENGE" || "SELECT_CHALLENGE" || "DEVICE_SRP_AUTH" || "DEVICE_PASSWORD_VERIFIER" || "ADMIN_NO_SRP_AUTH" || "NEW_PASSWORD_REQUIRED" || "SMS_OTP" || "PASSWORD" || "WEB_AUTHN" || "PASSWORD_SRP",
|
|
100
|
+
* // ],
|
|
97
101
|
* // };
|
|
98
102
|
*
|
|
99
103
|
* ```
|
|
@@ -129,7 +133,7 @@ declare const InitiateAuthCommand_base: {
|
|
|
129
133
|
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
|
|
130
134
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
131
135
|
* provided for SMS configuration. This can happen if you don't trust
|
|
132
|
-
*
|
|
136
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
133
137
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
134
138
|
*
|
|
135
139
|
* @throws {@link InvalidUserPoolConfigurationException} (client fault)
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ListDevicesRequest, ListDevicesResponse } from "../models/
|
|
4
|
+
import { ListDevicesRequest, ListDevicesResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ListGroupsRequest, ListGroupsResponse } from "../models/
|
|
4
|
+
import { ListGroupsRequest, ListGroupsResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ListIdentityProvidersRequest, ListIdentityProvidersResponse } from "../models/
|
|
4
|
+
import { ListIdentityProvidersRequest, ListIdentityProvidersResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ListResourceServersRequest, ListResourceServersResponse } from "../models/
|
|
4
|
+
import { ListResourceServersRequest, ListResourceServersResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/
|
|
4
|
+
import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ListUserImportJobsRequest, ListUserImportJobsResponse } from "../models/
|
|
4
|
+
import { ListUserImportJobsRequest, ListUserImportJobsResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ListUserPoolClientsRequest, ListUserPoolClientsResponse } from "../models/
|
|
4
|
+
import { ListUserPoolClientsRequest, ListUserPoolClientsResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ListUserPoolsRequest, ListUserPoolsResponse } from "../models/
|
|
4
|
+
import { ListUserPoolsRequest, ListUserPoolsResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ListUsersRequest, ListUsersResponse } from "../models/
|
|
4
|
+
import { ListUsersRequest, ListUsersResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ListUsersInGroupRequest, ListUsersInGroupResponse } from "../models/
|
|
4
|
+
import { ListUsersInGroupRequest, ListUsersInGroupResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
+
import { ListWebAuthnCredentialsRequest, ListWebAuthnCredentialsResponse } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListWebAuthnCredentialsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListWebAuthnCredentialsCommandInput extends ListWebAuthnCredentialsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListWebAuthnCredentialsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListWebAuthnCredentialsCommandOutput extends ListWebAuthnCredentialsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListWebAuthnCredentialsCommand_base: {
|
|
25
|
+
new (input: ListWebAuthnCredentialsCommandInput): import("@smithy/smithy-client").CommandImpl<ListWebAuthnCredentialsCommandInput, ListWebAuthnCredentialsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListWebAuthnCredentialsCommandInput): import("@smithy/smithy-client").CommandImpl<ListWebAuthnCredentialsCommandInput, ListWebAuthnCredentialsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Generates a list of the current user's registered passkey, or webauthN,
|
|
31
|
+
* credentials.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { CognitoIdentityProviderClient, ListWebAuthnCredentialsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
36
|
+
* // const { CognitoIdentityProviderClient, ListWebAuthnCredentialsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
37
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
38
|
+
* const input = { // ListWebAuthnCredentialsRequest
|
|
39
|
+
* AccessToken: "STRING_VALUE", // required
|
|
40
|
+
* NextToken: "STRING_VALUE",
|
|
41
|
+
* MaxResults: Number("int"),
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListWebAuthnCredentialsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListWebAuthnCredentialsResponse
|
|
46
|
+
* // Credentials: [ // WebAuthnCredentialDescriptionListType // required
|
|
47
|
+
* // { // WebAuthnCredentialDescription
|
|
48
|
+
* // CredentialId: "STRING_VALUE", // required
|
|
49
|
+
* // FriendlyCredentialName: "STRING_VALUE", // required
|
|
50
|
+
* // RelyingPartyId: "STRING_VALUE", // required
|
|
51
|
+
* // AuthenticatorAttachment: "STRING_VALUE",
|
|
52
|
+
* // AuthenticatorTransports: [ // WebAuthnAuthenticatorTransportsList // required
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // NextToken: "STRING_VALUE",
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @param ListWebAuthnCredentialsCommandInput - {@link ListWebAuthnCredentialsCommandInput}
|
|
64
|
+
* @returns {@link ListWebAuthnCredentialsCommandOutput}
|
|
65
|
+
* @see {@link ListWebAuthnCredentialsCommandInput} for command's `input` shape.
|
|
66
|
+
* @see {@link ListWebAuthnCredentialsCommandOutput} for command's `response` shape.
|
|
67
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
70
|
+
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
71
|
+
* ACL that's associated with your user pool.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
74
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
77
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
78
|
+
* parameter.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
81
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
85
|
+
*
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export declare class ListWebAuthnCredentialsCommand extends ListWebAuthnCredentialsCommand_base {
|
|
89
|
+
/** @internal type navigation helper, not in runtime. */
|
|
90
|
+
protected static __types: {
|
|
91
|
+
api: {
|
|
92
|
+
input: ListWebAuthnCredentialsRequest;
|
|
93
|
+
output: ListWebAuthnCredentialsResponse;
|
|
94
|
+
};
|
|
95
|
+
sdk: {
|
|
96
|
+
input: ListWebAuthnCredentialsCommandInput;
|
|
97
|
+
output: ListWebAuthnCredentialsCommandOutput;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { ResendConfirmationCodeRequest, ResendConfirmationCodeResponse } from "../models/
|
|
4
|
+
import { ResendConfirmationCodeRequest, ResendConfirmationCodeResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -43,7 +43,7 @@ declare const ResendConfirmationCodeCommand_base: {
|
|
|
43
43
|
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
|
|
44
44
|
* receive SMS messages might not be able to sign up, activate their accounts, or sign
|
|
45
45
|
* in.</p>
|
|
46
|
-
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web
|
|
46
|
+
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,
|
|
47
47
|
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
|
|
48
48
|
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
|
|
49
49
|
* mode</a>
|
|
@@ -120,7 +120,7 @@ declare const ResendConfirmationCodeCommand_base: {
|
|
|
120
120
|
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
|
|
121
121
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
122
122
|
* provided for SMS configuration. This can happen if you don't trust
|
|
123
|
-
*
|
|
123
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
124
124
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
125
125
|
*
|
|
126
126
|
* @throws {@link LimitExceededException} (client fault)
|