@aws-sdk/client-cognito-identity-provider 3.750.0 → 3.760.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 +4 -61
- package/dist-cjs/index.js +39 -6
- package/dist-es/models/models_0.js +13 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +13 -1
- package/dist-types/CognitoIdentityProvider.d.ts +5 -62
- package/dist-types/CognitoIdentityProviderClient.d.ts +5 -62
- package/dist-types/commands/AddCustomAttributesCommand.d.ts +0 -3
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +1 -2
- package/dist-types/commands/AdminCreateUserCommand.d.ts +12 -12
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +2 -2
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +10 -13
- package/dist-types/commands/AdminEnableUserCommand.d.ts +1 -1
- package/dist-types/commands/AdminGetDeviceCommand.d.ts +1 -1
- package/dist-types/commands/AdminGetUserCommand.d.ts +4 -3
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +3 -0
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +11 -12
- package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +1 -1
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +2 -12
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +0 -3
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +1 -1
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +10 -7
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +20 -20
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +0 -12
- package/dist-types/commands/ChangePasswordCommand.d.ts +1 -1
- package/dist-types/commands/CompleteWebAuthnRegistrationCommand.d.ts +2 -3
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +4 -0
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +7 -10
- package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateManagedLoginBrandingCommand.d.ts +0 -3
- package/dist-types/commands/CreateUserImportJobCommand.d.ts +1 -3
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +4 -5
- package/dist-types/commands/CreateUserPoolCommand.d.ts +8 -10
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +3 -3
- package/dist-types/commands/DeleteUserAttributesCommand.d.ts +3 -3
- package/dist-types/commands/DeleteUserCommand.d.ts +2 -2
- package/dist-types/commands/DeleteUserPoolCommand.d.ts +7 -1
- package/dist-types/commands/DeleteWebAuthnCredentialCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +1 -1
- package/dist-types/commands/ForgetDeviceCommand.d.ts +2 -2
- package/dist-types/commands/ForgotPasswordCommand.d.ts +6 -11
- package/dist-types/commands/GetCSVHeaderCommand.d.ts +26 -2
- package/dist-types/commands/GetDeviceCommand.d.ts +2 -1
- package/dist-types/commands/GetGroupCommand.d.ts +23 -2
- package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +3 -1
- package/dist-types/commands/GetLogDeliveryConfigurationCommand.d.ts +22 -1
- package/dist-types/commands/GetSigningCertificateCommand.d.ts +26 -5
- package/dist-types/commands/GetUICustomizationCommand.d.ts +5 -5
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +2 -3
- package/dist-types/commands/GetUserAuthFactorsCommand.d.ts +9 -3
- package/dist-types/commands/GetUserCommand.d.ts +1 -1
- package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +39 -1
- package/dist-types/commands/InitiateAuthCommand.d.ts +5 -2
- 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 +2 -1
- package/dist-types/commands/ListResourceServersCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -4
- package/dist-types/commands/ListUserImportJobsCommand.d.ts +3 -1
- package/dist-types/commands/ListUserPoolClientsCommand.d.ts +2 -1
- package/dist-types/commands/ListUserPoolsCommand.d.ts +2 -2
- package/dist-types/commands/ListUsersCommand.d.ts +2 -1
- package/dist-types/commands/ListUsersInGroupCommand.d.ts +2 -1
- package/dist-types/commands/ListWebAuthnCredentialsCommand.d.ts +9 -2
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +5 -2
- package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +3 -1
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +24 -5
- package/dist-types/commands/SetUICustomizationCommand.d.ts +23 -10
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +0 -3
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +2 -1
- package/dist-types/commands/SetUserSettingsCommand.d.ts +1 -1
- package/dist-types/commands/SignUpCommand.d.ts +3 -5
- package/dist-types/commands/StartUserImportJobCommand.d.ts +3 -1
- package/dist-types/commands/StartWebAuthnRegistrationCommand.d.ts +4 -6
- package/dist-types/commands/StopUserImportJobCommand.d.ts +3 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +13 -3
- package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +6 -2
- package/dist-types/commands/UpdateGroupCommand.d.ts +2 -1
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +4 -1
- package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +1 -5
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +4 -5
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +7 -4
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +8 -7
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +4 -3
- package/dist-types/commands/VerifyUserAttributeCommand.d.ts +5 -3
- package/dist-types/index.d.ts +5 -62
- package/dist-types/models/models_0.d.ts +730 -642
- package/dist-types/models/models_1.d.ts +834 -558
- package/dist-types/ts3.4/models/models_0.d.ts +9 -6
- package/dist-types/ts3.4/models/models_1.d.ts +6 -1
- package/package.json +12 -12
|
@@ -27,7 +27,28 @@ declare const GetLogDeliveryConfigurationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Given a user pool ID, returns the logging configuration. User pools can export
|
|
31
|
+
* message-delivery error and threat-protection activity logs to external Amazon Web Services services. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html">Exporting user pool logs</a>.</p>
|
|
32
|
+
* <note>
|
|
33
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
34
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
35
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
36
|
+
* <p class="title">
|
|
37
|
+
* <b>Learn more</b>
|
|
38
|
+
* </p>
|
|
39
|
+
* <ul>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>
|
|
42
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
43
|
+
* </p>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>
|
|
47
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
|
|
48
|
+
* </p>
|
|
49
|
+
* </li>
|
|
50
|
+
* </ul>
|
|
51
|
+
* </note>
|
|
31
52
|
* @example
|
|
32
53
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
54
|
* ```javascript
|
|
@@ -27,11 +27,32 @@ declare const GetSigningCertificateCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
30
|
+
* <p>Given a user pool ID, returns the signing certificate for SAML 2.0 federation.</p>
|
|
31
|
+
* <p>Issued certificates are valid for 10 years from the date of issue. Amazon Cognito issues and
|
|
32
|
+
* assigns a new signing certificate annually. This renewal process returns a new value in
|
|
33
|
+
* the response to <code>GetSigningCertificate</code>, but doesn't invalidate the original
|
|
34
|
+
* certificate.</p>
|
|
35
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-SAML-signing-encryption.html#cognito-user-pools-SAML-signing">Signing SAML requests</a>.</p>
|
|
36
|
+
* <note>
|
|
37
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
38
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
39
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
40
|
+
* <p class="title">
|
|
41
|
+
* <b>Learn more</b>
|
|
42
|
+
* </p>
|
|
43
|
+
* <ul>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>
|
|
46
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
47
|
+
* </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>
|
|
51
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
|
|
52
|
+
* </p>
|
|
53
|
+
* </li>
|
|
54
|
+
* </ul>
|
|
55
|
+
* </note>
|
|
35
56
|
* @example
|
|
36
57
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
58
|
* ```javascript
|
|
@@ -27,11 +27,11 @@ declare const GetUICustomizationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
30
|
+
* <p>Given a user pool ID or app client, returns information about classic hosted UI
|
|
31
|
+
* branding that you applied, if any. Returns user-pool level branding information if no
|
|
32
|
+
* app client branding is applied, or if you don't specify an app client ID. Returns
|
|
33
|
+
* an empty object if you haven't applied hosted UI branding to either the client or
|
|
34
|
+
* the user pool. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html">Hosted UI (classic) branding</a>.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -27,9 +27,8 @@ declare const GetUserAttributeVerificationCodeCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
* request.</p>
|
|
30
|
+
* <p>Given an attribute name, sends a user attribute verification code for the specified
|
|
31
|
+
* attribute name to the currently signed-in user.</p>
|
|
33
32
|
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
34
33
|
* <note>
|
|
35
34
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
@@ -34,11 +34,17 @@ declare const GetUserAuthFactorsCommand_base: {
|
|
|
34
34
|
* <p>The user's multi-factor authentication (MFA) preferences.</p>
|
|
35
35
|
* </li>
|
|
36
36
|
* <li>
|
|
37
|
-
* <p>The user's options
|
|
38
|
-
*
|
|
39
|
-
* <code>PREFERRED_CHALLENGE</code>request.</p>
|
|
37
|
+
* <p>The user's options for choice-based authentication with the
|
|
38
|
+
* <code>USER_AUTH</code> flow.</p>
|
|
40
39
|
* </li>
|
|
41
40
|
* </ol>
|
|
41
|
+
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
42
|
+
* <note>
|
|
43
|
+
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
44
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
45
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
46
|
+
* Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
47
|
+
* </note>
|
|
42
48
|
* @example
|
|
43
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
44
50
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const GetUserCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets
|
|
30
|
+
* <p>Gets user attributes and and MFA settings for the currently signed-in user.</p>
|
|
31
31
|
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
@@ -28,7 +28,45 @@ declare const GetUserPoolMfaConfigCommand_base: {
|
|
|
28
28
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
29
|
};
|
|
30
30
|
/**
|
|
31
|
-
* <p>
|
|
31
|
+
* <p>Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators
|
|
32
|
+
* and for multi-factor authentication (MFA). This operation describes the
|
|
33
|
+
* following:</p>
|
|
34
|
+
* <ul>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>The WebAuthn relying party (RP) ID and user-verification settings.</p>
|
|
37
|
+
* </li>
|
|
38
|
+
* <li>
|
|
39
|
+
* <p>The required, optional, or disabled state of MFA for all user pool
|
|
40
|
+
* users.</p>
|
|
41
|
+
* </li>
|
|
42
|
+
* <li>
|
|
43
|
+
* <p>The message templates for email and SMS MFA.</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>The enabled or disabled state of time-based one-time password (TOTP)
|
|
47
|
+
* MFA.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* </ul>
|
|
50
|
+
* <note>
|
|
51
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
52
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
53
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
54
|
+
* <p class="title">
|
|
55
|
+
* <b>Learn more</b>
|
|
56
|
+
* </p>
|
|
57
|
+
* <ul>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>
|
|
60
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
61
|
+
* </p>
|
|
62
|
+
* </li>
|
|
63
|
+
* <li>
|
|
64
|
+
* <p>
|
|
65
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
|
|
66
|
+
* </p>
|
|
67
|
+
* </li>
|
|
68
|
+
* </ul>
|
|
69
|
+
* </note>
|
|
32
70
|
* @example
|
|
33
71
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
72
|
* ```javascript
|
|
@@ -27,8 +27,11 @@ declare const InitiateAuthCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
30
|
+
* <p>Declares an authentication flow and initiates sign-in for a user in the Amazon Cognito user
|
|
31
|
+
* directory. Amazon Cognito might respond with an additional challenge or an
|
|
32
|
+
* <code>AuthenticationResult</code> that contains the outcome of a successful
|
|
33
|
+
* authentication. You can't sign in a user with a federated IdP with
|
|
34
|
+
* <code>InitiateAuth</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html">Authentication</a>.</p>
|
|
32
35
|
* <note>
|
|
33
36
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
34
37
|
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
@@ -27,7 +27,7 @@ declare const ListDevicesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the
|
|
30
|
+
* <p>Lists the devices that Amazon Cognito has registered to the currently signed-in user. For more
|
|
31
31
|
* 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>.</p>
|
|
32
32
|
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
33
33
|
* <note>
|
|
@@ -27,7 +27,7 @@ declare const ListGroupsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Given a user pool ID, returns user pool groups and their details.</p>
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
33
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -27,7 +27,8 @@ declare const ListIdentityProvidersCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Given a user pool ID, returns information about configured identity providers (IdPs).
|
|
31
|
+
* For more information about IdPs, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html">Third-party IdP sign-in</a>.</p>
|
|
31
32
|
* <note>
|
|
32
33
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
34
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -27,7 +27,8 @@ declare const ListResourceServersCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Given a user pool ID, returns all resource servers and their details. For more
|
|
31
|
+
* information about resource servers, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html">Access control with resource servers</a>.</p>
|
|
31
32
|
* <note>
|
|
32
33
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
34
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -27,10 +27,9 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the tags that are assigned to an Amazon Cognito user pool
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* <p>You can use this action up to 10 times per second, per account.</p>
|
|
30
|
+
* <p>Lists the tags that are assigned to an Amazon Cognito user pool. For more information, see
|
|
31
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html">Tagging
|
|
32
|
+
* resources</a>.</p>
|
|
34
33
|
* @example
|
|
35
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
35
|
* ```javascript
|
|
@@ -27,7 +27,9 @@ declare const ListUserImportJobsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Given a user pool ID, returns user import jobs and their details. Import jobs are
|
|
31
|
+
* retained in user pool configuration so that you can stage, stop, start, review, and
|
|
32
|
+
* delete them. For more information about user import, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html">Importing users from a CSV file</a>.</p>
|
|
31
33
|
* <note>
|
|
32
34
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
35
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -27,7 +27,8 @@ declare const ListUserPoolClientsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Given a user pool ID, lists app clients. App clients are sets of rules for the access
|
|
31
|
+
* that you want a user pool to grant to one application. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html">App clients</a>.</p>
|
|
31
32
|
* <note>
|
|
32
33
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
34
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -27,7 +27,7 @@ declare const ListUserPoolsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists
|
|
30
|
+
* <p>Lists user pools and their details in the current Amazon Web Services account.</p>
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
33
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -77,7 +77,7 @@ declare const ListUserPoolsCommand_base: {
|
|
|
77
77
|
* // PreTokenGeneration: "STRING_VALUE",
|
|
78
78
|
* // UserMigration: "STRING_VALUE",
|
|
79
79
|
* // PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType
|
|
80
|
-
* // LambdaVersion: "V1_0" || "V2_0", // required
|
|
80
|
+
* // LambdaVersion: "V1_0" || "V2_0" || "V3_0", // required
|
|
81
81
|
* // LambdaArn: "STRING_VALUE", // required
|
|
82
82
|
* // },
|
|
83
83
|
* // CustomSMSSender: { // CustomSMSLambdaVersionConfigType
|
|
@@ -27,7 +27,8 @@ declare const ListUsersCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Given a user pool ID, returns a list of users and their basic details in a user
|
|
31
|
+
* pool.</p>
|
|
31
32
|
* <note>
|
|
32
33
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
34
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -27,7 +27,8 @@ declare const ListUsersInGroupCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Given a user pool ID and a group name, returns a list of users in the group. For more
|
|
31
|
+
* information about user pool groups, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html">Adding groups to a user pool</a>.</p>
|
|
31
32
|
* <note>
|
|
32
33
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
34
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -27,8 +27,15 @@ declare const ListWebAuthnCredentialsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Generates a list of the
|
|
31
|
-
* credentials.</p>
|
|
30
|
+
* <p>Generates a list of the currently signed-in user's registered passkey, or
|
|
31
|
+
* WebAuthn, credentials.</p>
|
|
32
|
+
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
33
|
+
* <note>
|
|
34
|
+
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
35
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
36
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
37
|
+
* Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
38
|
+
* </note>
|
|
32
39
|
* @example
|
|
33
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
41
|
* ```javascript
|
|
@@ -27,8 +27,11 @@ declare const ResendConfirmationCodeCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Resends the
|
|
31
|
-
* user
|
|
30
|
+
* <p>Resends the code that confirms a new account for a user who has signed up in your user
|
|
31
|
+
* pool. Amazon Cognito sends confirmation codes to the user attribute in the
|
|
32
|
+
* <code>AutoVerifiedAttributes</code> property of your user pool. When you prompt new
|
|
33
|
+
* users for the confirmation code, include a "Resend code" option that generates a call to
|
|
34
|
+
* this API operation.</p>
|
|
32
35
|
* <note>
|
|
33
36
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
34
37
|
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
@@ -28,7 +28,9 @@ declare const SetLogDeliveryConfigurationCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Sets up or modifies the logging configuration of a user pool. User pools can export
|
|
31
|
-
* user notification logs and
|
|
31
|
+
* user notification logs and, when threat protection is active, user-activity logs. For
|
|
32
|
+
* more information, see <a href="cognito/latest/developerguide/exporting-quotas-and-usage.html">Exporting user
|
|
33
|
+
* pool logs</a>.</p>
|
|
32
34
|
* @example
|
|
33
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
36
|
* ```javascript
|
|
@@ -27,11 +27,30 @@ declare const SetRiskConfigurationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Configures
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
30
|
+
* <p>Configures threat protection for a user pool or app client. Sets configuration for the
|
|
31
|
+
* following.</p>
|
|
32
|
+
* <ul>
|
|
33
|
+
* <li>
|
|
34
|
+
* <p>Responses to risks with adaptive authentication</p>
|
|
35
|
+
* </li>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>Responses to vulnerable passwords with compromised-credentials
|
|
38
|
+
* detection</p>
|
|
39
|
+
* </li>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>Notifications to users who have had risky activity detected</p>
|
|
42
|
+
* </li>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>IP-address denylist and allowlist</p>
|
|
45
|
+
* </li>
|
|
46
|
+
* </ul>
|
|
47
|
+
* <p>To set the risk configuration for the user pool to defaults, send this request with
|
|
48
|
+
* only the <code>UserPoolId</code> parameter. To reset the threat protection settings of
|
|
49
|
+
* an app client to be inherited from the user pool, send <code>UserPoolId</code> and
|
|
50
|
+
* <code>ClientId</code> parameters only. To change threat protection to audit-only or
|
|
51
|
+
* off, update the value of <code>UserPoolAddOns</code> in an <code>UpdateUserPool</code>
|
|
52
|
+
* request. 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">
|
|
53
|
+
* Plus tier</a>.</p>
|
|
35
54
|
* @example
|
|
36
55
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
56
|
* ```javascript
|
|
@@ -27,18 +27,31 @@ declare const SetUICustomizationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
* <p>
|
|
33
|
-
* <code>
|
|
34
|
-
*
|
|
35
|
-
* used for every client that has no previously set UI customization. If you specify UI
|
|
36
|
-
* customization settings for a particular client, it will no longer return to the
|
|
30
|
+
* <p>Configures UI branding settings for domains with the hosted UI (classic) branding
|
|
31
|
+
* version. Your user pool must have a domain. Configure a domain with .</p>
|
|
32
|
+
* <p>Set the default configuration for all clients with a <code>ClientId</code> of
|
|
33
|
+
* <code>ALL</code>. When the <code>ClientId</code> value is an app client ID, the
|
|
34
|
+
* settings you pass in this request apply to that app client and override the default
|
|
37
35
|
* <code>ALL</code> configuration.</p>
|
|
38
36
|
* <note>
|
|
39
|
-
* <p>
|
|
40
|
-
*
|
|
41
|
-
*
|
|
37
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
38
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
39
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
40
|
+
* <p class="title">
|
|
41
|
+
* <b>Learn more</b>
|
|
42
|
+
* </p>
|
|
43
|
+
* <ul>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>
|
|
46
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
47
|
+
* </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>
|
|
51
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
|
|
52
|
+
* </p>
|
|
53
|
+
* </li>
|
|
54
|
+
* </ul>
|
|
42
55
|
* </note>
|
|
43
56
|
* @example
|
|
44
57
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -36,9 +36,6 @@ declare const SetUserMFAPreferenceCommand_base: {
|
|
|
36
36
|
* unless device tracking is turned on and the device has been trusted. If you want MFA to
|
|
37
37
|
* be applied selectively based on the assessed risk level of sign-in attempts, deactivate
|
|
38
38
|
* MFA for users and turn on Adaptive Authentication for the user pool.</p>
|
|
39
|
-
* <p>This operation doesn't reset an existing TOTP MFA for a user. To register a new
|
|
40
|
-
* TOTP factor for a user, make an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html">AssociateSoftwareToken</a> request. For more information,
|
|
41
|
-
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-totp.html">TOTP software token MFA</a>.</p>
|
|
42
39
|
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
43
40
|
* <note>
|
|
44
41
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
@@ -27,7 +27,8 @@ declare const SetUserPoolMfaConfigCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Sets
|
|
30
|
+
* <p>Sets user pool multi-factor authentication (MFA) and passkey configuration. For more
|
|
31
|
+
* information about user pool MFA, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html">Adding MFA</a>. For more information about WebAuthn passkeys see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html#amazon-cognito-user-pools-authentication-flow-methods-passkey">Authentication flows</a>.</p>
|
|
31
32
|
* <note>
|
|
32
33
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
33
34
|
* require you to register an origination phone number before you can send SMS messages
|
|
@@ -30,7 +30,7 @@ declare const SetUserSettingsCommand_base: {
|
|
|
30
30
|
* <p>
|
|
31
31
|
* <i>This action is no longer supported.</i> You can use it to configure
|
|
32
32
|
* only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software
|
|
33
|
-
* token
|
|
33
|
+
* token or email MFA.</p>
|
|
34
34
|
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
35
35
|
* <note>
|
|
36
36
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
@@ -27,8 +27,8 @@ declare const SignUpCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Registers
|
|
31
|
-
* user
|
|
30
|
+
* <p>Registers a user with an app client and requests a user name, password, and user
|
|
31
|
+
* attributes in the user pool.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
34
34
|
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
@@ -56,9 +56,7 @@ declare const SignUpCommand_base: {
|
|
|
56
56
|
* if you have exceeded a rate quota for email or SMS messages, and if your user pool
|
|
57
57
|
* automatically verifies email addresses or phone numbers. When you get this exception in
|
|
58
58
|
* the response, the user is successfully created and is in an <code>UNCONFIRMED</code>
|
|
59
|
-
* state
|
|
60
|
-
* with an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminConfirmSignUp.html">
|
|
61
|
-
* AdminConfirmSignUp</a> request.</p>
|
|
59
|
+
* state.</p>
|
|
62
60
|
* @example
|
|
63
61
|
* Use a bare-bones client and the command you need to make an API call.
|
|
64
62
|
* ```javascript
|
|
@@ -27,7 +27,9 @@ declare const StartUserImportJobCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Instructs your user pool to start importing users from a CSV file that contains their
|
|
31
|
+
* usernames and attributes. For more information about importing users from a CSV file,
|
|
32
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html">Importing users from a CSV file</a>.</p>
|
|
31
33
|
* @example
|
|
32
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
35
|
* ```javascript
|
|
@@ -27,12 +27,10 @@ declare const StartWebAuthnRegistrationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Requests credential creation options from your user pool for
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* <p>After users present this data and register with their passkey provider, return the
|
|
35
|
-
* response to your user pool in a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CompleteWebAuthnRegistration.html"> CompleteWebAuthnRegistration</a> API request.</p>
|
|
30
|
+
* <p>Requests credential creation options from your user pool for the currently signed-in
|
|
31
|
+
* user. Returns information about the user pool, the user profile, and authentication
|
|
32
|
+
* requirements. Users must provide this information in their request to enroll your
|
|
33
|
+
* application with their passkey provider.</p>
|
|
36
34
|
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
|
|
37
35
|
* @example
|
|
38
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,7 +27,9 @@ declare const StopUserImportJobCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Instructs your user pool to stop a running job that's importing users from a CSV
|
|
31
|
+
* file that contains their usernames and attributes. For more information about importing
|
|
32
|
+
* users from a CSV file, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html">Importing users from a CSV file</a>.</p>
|
|
31
33
|
* @example
|
|
32
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
35
|
* ```javascript
|
|
@@ -27,8 +27,7 @@ declare const UntagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* times per second, per account.</p>
|
|
30
|
+
* <p>Given tag IDs that you previously assigned to a user pool, removes them.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -27,9 +27,19 @@ declare const UpdateAuthEventFeedbackCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Provides the feedback for an authentication event
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Provides the feedback for an authentication event generated by threat protection
|
|
31
|
+
* features. The user's response indicates that you think that the event either was from a
|
|
32
|
+
* valid user or was an unwanted authentication attempt. This feedback improves the risk
|
|
33
|
+
* evaluation decision for the user pool as part of Amazon Cognito threat protection.
|
|
34
|
+
* 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">
|
|
35
|
+
* Plus tier</a>.</p>
|
|
36
|
+
* <p>This operation requires a <code>FeedbackToken</code> that Amazon Cognito generates and adds to
|
|
37
|
+
* notification emails when users have potentially suspicious authentication events. Users
|
|
38
|
+
* invoke this operation when they select the link that corresponds to
|
|
39
|
+
* <code>\{one-click-link-valid\}</code> or <code>\{one-click-link-invalid\}</code> in your
|
|
40
|
+
* notification template. Because <code>FeedbackToken</code> is a required parameter, you
|
|
41
|
+
* can' make requests to <code>UpdateAuthEventFeedback</code> without the contents of
|
|
42
|
+
* the notification email message.</p>
|
|
33
43
|
* <note>
|
|
34
44
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
35
45
|
* this operation, you can't use IAM credentials to authorize requests, and you can't
|