@aws-sdk/client-cognito-identity-provider 3.758.0 → 3.768.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 +121 -88
- 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 +749 -656
- package/dist-types/models/models_1.d.ts +837 -560
- 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 +1 -1
|
@@ -612,6 +612,18 @@ export class WebAuthnRelyingPartyMismatchException extends __BaseException {
|
|
|
612
612
|
Object.setPrototypeOf(this, WebAuthnRelyingPartyMismatchException.prototype);
|
|
613
613
|
}
|
|
614
614
|
}
|
|
615
|
+
export class DeviceKeyExistsException extends __BaseException {
|
|
616
|
+
name = "DeviceKeyExistsException";
|
|
617
|
+
$fault = "client";
|
|
618
|
+
constructor(opts) {
|
|
619
|
+
super({
|
|
620
|
+
name: "DeviceKeyExistsException",
|
|
621
|
+
$fault: "client",
|
|
622
|
+
...opts,
|
|
623
|
+
});
|
|
624
|
+
Object.setPrototypeOf(this, DeviceKeyExistsException.prototype);
|
|
625
|
+
}
|
|
626
|
+
}
|
|
615
627
|
export class GroupExistsException extends __BaseException {
|
|
616
628
|
name = "GroupExistsException";
|
|
617
629
|
$fault = "client";
|
|
@@ -683,6 +695,7 @@ export const CustomSMSSenderLambdaVersionType = {
|
|
|
683
695
|
export const PreTokenGenerationLambdaVersionType = {
|
|
684
696
|
V1_0: "V1_0",
|
|
685
697
|
V2_0: "V2_0",
|
|
698
|
+
V3_0: "V3_0",
|
|
686
699
|
};
|
|
687
700
|
export const UserPoolMfaType = {
|
|
688
701
|
OFF: "OFF",
|
|
@@ -828,10 +841,6 @@ export const LogLevel = {
|
|
|
828
841
|
ERROR: "ERROR",
|
|
829
842
|
INFO: "INFO",
|
|
830
843
|
};
|
|
831
|
-
export const UserVerificationType = {
|
|
832
|
-
PREFERRED: "preferred",
|
|
833
|
-
REQUIRED: "required",
|
|
834
|
-
};
|
|
835
844
|
export const AdminAddUserToGroupRequestFilterSensitiveLog = (obj) => ({
|
|
836
845
|
...obj,
|
|
837
846
|
...(obj.Username && { Username: SENSITIVE_STRING }),
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import { SENSITIVE_STRING } from "@smithy/smithy-client";
|
|
2
2
|
import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
|
|
3
3
|
import { AttributeTypeFilterSensitiveLog, AuthenticationResultTypeFilterSensitiveLog, RiskConfigurationTypeFilterSensitiveLog, UICustomizationTypeFilterSensitiveLog, UserPoolClientTypeFilterSensitiveLog, UserTypeFilterSensitiveLog, } from "./models_0";
|
|
4
|
+
export const UserVerificationType = {
|
|
5
|
+
PREFERRED: "preferred",
|
|
6
|
+
REQUIRED: "required",
|
|
7
|
+
};
|
|
4
8
|
export class UnauthorizedException extends __BaseException {
|
|
5
9
|
name = "UnauthorizedException";
|
|
6
10
|
$fault = "client";
|
|
@@ -2,7 +2,7 @@ import { loadRestJsonErrorCode, parseJsonBody as parseBody, parseJsonErrorBody a
|
|
|
2
2
|
import { HttpRequest as __HttpRequest } from "@smithy/protocol-http";
|
|
3
3
|
import { _json, collectBody, decorateServiceException as __decorateServiceException, expectBoolean as __expectBoolean, expectInt32 as __expectInt32, expectLong as __expectLong, expectNonNull as __expectNonNull, expectNumber as __expectNumber, expectString as __expectString, parseEpochTimestamp as __parseEpochTimestamp, take, withBaseException, } from "@smithy/smithy-client";
|
|
4
4
|
import { CognitoIdentityProviderServiceException as __BaseException } from "../models/CognitoIdentityProviderServiceException";
|
|
5
|
-
import { AliasExistsException, CodeDeliveryFailureException, CodeMismatchException, ConcurrentModificationException, DuplicateProviderException, ExpiredCodeException, FeatureUnavailableInTierException, ForbiddenException, GroupExistsException, InternalErrorException, InvalidEmailRoleAccessPolicyException, InvalidLambdaResponseException, InvalidOAuthFlowException, InvalidParameterException, InvalidPasswordException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidUserPoolConfigurationException, LimitExceededException, ManagedLoginBrandingExistsException, MFAMethodNotFoundException, NotAuthorizedException, PasswordHistoryPolicyViolationException, PasswordResetRequiredException, PreconditionNotMetException, ResourceNotFoundException, ScopeDoesNotExistException, SoftwareTokenMFANotFoundException, TierChangeNotAllowedException, TooManyFailedAttemptsException, TooManyRequestsException, UnexpectedLambdaException, UnsupportedIdentityProviderException, UnsupportedUserStateException, UserImportInProgressException, UserLambdaValidationException, UsernameExistsException, UserNotConfirmedException, UserNotFoundException, UserPoolAddOnNotEnabledException, UserPoolTaggingException, WebAuthnChallengeNotFoundException, WebAuthnClientMismatchException, WebAuthnCredentialNotSupportedException, WebAuthnNotEnabledException, WebAuthnOriginNotAllowedException, WebAuthnRelyingPartyMismatchException, } from "../models/models_0";
|
|
5
|
+
import { AliasExistsException, CodeDeliveryFailureException, CodeMismatchException, ConcurrentModificationException, DeviceKeyExistsException, DuplicateProviderException, ExpiredCodeException, FeatureUnavailableInTierException, ForbiddenException, GroupExistsException, InternalErrorException, InvalidEmailRoleAccessPolicyException, InvalidLambdaResponseException, InvalidOAuthFlowException, InvalidParameterException, InvalidPasswordException, InvalidSmsRoleAccessPolicyException, InvalidSmsRoleTrustRelationshipException, InvalidUserPoolConfigurationException, LimitExceededException, ManagedLoginBrandingExistsException, MFAMethodNotFoundException, NotAuthorizedException, PasswordHistoryPolicyViolationException, PasswordResetRequiredException, PreconditionNotMetException, ResourceNotFoundException, ScopeDoesNotExistException, SoftwareTokenMFANotFoundException, TierChangeNotAllowedException, TooManyFailedAttemptsException, TooManyRequestsException, UnexpectedLambdaException, UnsupportedIdentityProviderException, UnsupportedUserStateException, UserImportInProgressException, UserLambdaValidationException, UsernameExistsException, UserNotConfirmedException, UserNotFoundException, UserPoolAddOnNotEnabledException, UserPoolTaggingException, WebAuthnChallengeNotFoundException, WebAuthnClientMismatchException, WebAuthnCredentialNotSupportedException, WebAuthnNotEnabledException, WebAuthnOriginNotAllowedException, WebAuthnRelyingPartyMismatchException, } from "../models/models_0";
|
|
6
6
|
import { EnableSoftwareTokenMFAException, UnauthorizedException, UnsupportedOperationException, UnsupportedTokenTypeException, WebAuthnConfigurationMissingException, } from "../models/models_1";
|
|
7
7
|
export const se_AddCustomAttributesCommand = async (input, context) => {
|
|
8
8
|
const headers = sharedHeaders("AddCustomAttributes");
|
|
@@ -2236,6 +2236,9 @@ const de_CommandError = async (output, context) => {
|
|
|
2236
2236
|
case "WebAuthnRelyingPartyMismatchException":
|
|
2237
2237
|
case "com.amazonaws.cognitoidentityprovider#WebAuthnRelyingPartyMismatchException":
|
|
2238
2238
|
throw await de_WebAuthnRelyingPartyMismatchExceptionRes(parsedOutput, context);
|
|
2239
|
+
case "DeviceKeyExistsException":
|
|
2240
|
+
case "com.amazonaws.cognitoidentityprovider#DeviceKeyExistsException":
|
|
2241
|
+
throw await de_DeviceKeyExistsExceptionRes(parsedOutput, context);
|
|
2239
2242
|
case "GroupExistsException":
|
|
2240
2243
|
case "com.amazonaws.cognitoidentityprovider#GroupExistsException":
|
|
2241
2244
|
throw await de_GroupExistsExceptionRes(parsedOutput, context);
|
|
@@ -2323,6 +2326,15 @@ const de_ConcurrentModificationExceptionRes = async (parsedOutput, context) => {
|
|
|
2323
2326
|
});
|
|
2324
2327
|
return __decorateServiceException(exception, body);
|
|
2325
2328
|
};
|
|
2329
|
+
const de_DeviceKeyExistsExceptionRes = async (parsedOutput, context) => {
|
|
2330
|
+
const body = parsedOutput.body;
|
|
2331
|
+
const deserialized = _json(body);
|
|
2332
|
+
const exception = new DeviceKeyExistsException({
|
|
2333
|
+
$metadata: deserializeMetadata(parsedOutput),
|
|
2334
|
+
...deserialized,
|
|
2335
|
+
});
|
|
2336
|
+
return __decorateServiceException(exception, body);
|
|
2337
|
+
};
|
|
2326
2338
|
const de_DuplicateProviderExceptionRes = async (parsedOutput, context) => {
|
|
2327
2339
|
const body = parsedOutput.body;
|
|
2328
2340
|
const deserialized = _json(body);
|
|
@@ -798,8 +798,8 @@ export interface CognitoIdentityProvider {
|
|
|
798
798
|
/**
|
|
799
799
|
* <p>With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To
|
|
800
800
|
* authenticate users from third-party identity providers (IdPs) in this API, you can
|
|
801
|
-
*
|
|
802
|
-
* about the authentication and authorization of federated users at <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html">Adding user pool sign-in through a third party</a> and in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html">User pool federation endpoints and
|
|
801
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html">link IdP users to native user profiles</a>. Learn more
|
|
802
|
+
* about the authentication and authorization of federated users at <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html">Adding user pool sign-in through a third party</a> and in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html">User pool federation endpoints and managed login reference</a>.</p>
|
|
803
803
|
* <p>This API reference provides detailed information about API operations and object types
|
|
804
804
|
* in Amazon Cognito.</p>
|
|
805
805
|
* <p>Along with resource management operations, the Amazon Cognito user pools API includes classes
|
|
@@ -820,68 +820,11 @@ export interface CognitoIdentityProvider {
|
|
|
820
820
|
* requests to manage, authenticate, or authorize a user.</p>
|
|
821
821
|
* </li>
|
|
822
822
|
* </ol>
|
|
823
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations
|
|
824
|
-
*
|
|
823
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-public-server-side.html#user-pools-API-operations">Understanding API, OIDC, and managed login pages
|
|
824
|
+
* authentication</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
825
825
|
* <p>With your Amazon Web Services SDK, you can build the logic to support operational flows in every use
|
|
826
826
|
* case for this API. You can also make direct REST API requests to <a href="https://docs.aws.amazon.com/general/latest/gr/cognito_identity.html#cognito_identity_your_user_pools_region">Amazon Cognito user pools service endpoints</a>. The following links can get you started
|
|
827
|
-
* with the <code>CognitoIdentityProvider</code> client in
|
|
828
|
-
* SDKs.</p>
|
|
829
|
-
* <ul>
|
|
830
|
-
* <li>
|
|
831
|
-
* <p>
|
|
832
|
-
* <a href="https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp">Amazon Web Services
|
|
833
|
-
* Command Line Interface</a>
|
|
834
|
-
* </p>
|
|
835
|
-
* </li>
|
|
836
|
-
* <li>
|
|
837
|
-
* <p>
|
|
838
|
-
* <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html">Amazon Web Services SDK for .NET</a>
|
|
839
|
-
* </p>
|
|
840
|
-
* </li>
|
|
841
|
-
* <li>
|
|
842
|
-
* <p>
|
|
843
|
-
* <a href="https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-cognito-idp/html/class_aws_1_1_cognito_identity_provider_1_1_cognito_identity_provider_client.html">Amazon Web Services SDK for C++</a>
|
|
844
|
-
* </p>
|
|
845
|
-
* </li>
|
|
846
|
-
* <li>
|
|
847
|
-
* <p>
|
|
848
|
-
* <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider">Amazon Web Services SDK for Go</a>
|
|
849
|
-
* </p>
|
|
850
|
-
* </li>
|
|
851
|
-
* <li>
|
|
852
|
-
* <p>
|
|
853
|
-
* <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html">Amazon Web Services SDK for Java V2</a>
|
|
854
|
-
* </p>
|
|
855
|
-
* </li>
|
|
856
|
-
* <li>
|
|
857
|
-
* <p>
|
|
858
|
-
* <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html">Amazon Web Services
|
|
859
|
-
* SDK for JavaScript</a>
|
|
860
|
-
* </p>
|
|
861
|
-
* </li>
|
|
862
|
-
* <li>
|
|
863
|
-
* <p>
|
|
864
|
-
* <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html">Amazon Web Services SDK for PHP
|
|
865
|
-
* V3</a>
|
|
866
|
-
* </p>
|
|
867
|
-
* </li>
|
|
868
|
-
* <li>
|
|
869
|
-
* <p>
|
|
870
|
-
* <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html">Amazon Web Services SDK for Python</a>
|
|
871
|
-
* </p>
|
|
872
|
-
* </li>
|
|
873
|
-
* <li>
|
|
874
|
-
* <p>
|
|
875
|
-
* <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html">Amazon Web Services SDK
|
|
876
|
-
* for Ruby V3</a>
|
|
877
|
-
* </p>
|
|
878
|
-
* </li>
|
|
879
|
-
* <li>
|
|
880
|
-
* <p>
|
|
881
|
-
* <a href="https://sdk.amazonaws.com/kotlin/api/latest/cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider/-cognito-identity-provider-client/index.html">Amazon Web Services SDK for Kotlin</a>
|
|
882
|
-
* </p>
|
|
883
|
-
* </li>
|
|
884
|
-
* </ul>
|
|
827
|
+
* with the <code>CognitoIdentityProvider</code> client in supported Amazon Web Services SDKs.</p>
|
|
885
828
|
* <p>To get started with an Amazon Web Services SDK, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>. For example actions and scenarios, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/service_code_examples_cognito-identity-provider.html">Code examples for Amazon Cognito Identity Provider using Amazon Web Services
|
|
886
829
|
* SDKs</a>.</p>
|
|
887
830
|
* @public
|
|
@@ -284,8 +284,8 @@ export interface CognitoIdentityProviderClientResolvedConfig extends CognitoIden
|
|
|
284
284
|
/**
|
|
285
285
|
* <p>With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To
|
|
286
286
|
* authenticate users from third-party identity providers (IdPs) in this API, you can
|
|
287
|
-
*
|
|
288
|
-
* about the authentication and authorization of federated users at <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html">Adding user pool sign-in through a third party</a> and in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html">User pool federation endpoints and
|
|
287
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html">link IdP users to native user profiles</a>. Learn more
|
|
288
|
+
* about the authentication and authorization of federated users at <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html">Adding user pool sign-in through a third party</a> and in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html">User pool federation endpoints and managed login reference</a>.</p>
|
|
289
289
|
* <p>This API reference provides detailed information about API operations and object types
|
|
290
290
|
* in Amazon Cognito.</p>
|
|
291
291
|
* <p>Along with resource management operations, the Amazon Cognito user pools API includes classes
|
|
@@ -306,68 +306,11 @@ export interface CognitoIdentityProviderClientResolvedConfig extends CognitoIden
|
|
|
306
306
|
* requests to manage, authenticate, or authorize a user.</p>
|
|
307
307
|
* </li>
|
|
308
308
|
* </ol>
|
|
309
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations
|
|
310
|
-
*
|
|
309
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-public-server-side.html#user-pools-API-operations">Understanding API, OIDC, and managed login pages
|
|
310
|
+
* authentication</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
311
311
|
* <p>With your Amazon Web Services SDK, you can build the logic to support operational flows in every use
|
|
312
312
|
* case for this API. You can also make direct REST API requests to <a href="https://docs.aws.amazon.com/general/latest/gr/cognito_identity.html#cognito_identity_your_user_pools_region">Amazon Cognito user pools service endpoints</a>. The following links can get you started
|
|
313
|
-
* with the <code>CognitoIdentityProvider</code> client in
|
|
314
|
-
* SDKs.</p>
|
|
315
|
-
* <ul>
|
|
316
|
-
* <li>
|
|
317
|
-
* <p>
|
|
318
|
-
* <a href="https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp">Amazon Web Services
|
|
319
|
-
* Command Line Interface</a>
|
|
320
|
-
* </p>
|
|
321
|
-
* </li>
|
|
322
|
-
* <li>
|
|
323
|
-
* <p>
|
|
324
|
-
* <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html">Amazon Web Services SDK for .NET</a>
|
|
325
|
-
* </p>
|
|
326
|
-
* </li>
|
|
327
|
-
* <li>
|
|
328
|
-
* <p>
|
|
329
|
-
* <a href="https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-cognito-idp/html/class_aws_1_1_cognito_identity_provider_1_1_cognito_identity_provider_client.html">Amazon Web Services SDK for C++</a>
|
|
330
|
-
* </p>
|
|
331
|
-
* </li>
|
|
332
|
-
* <li>
|
|
333
|
-
* <p>
|
|
334
|
-
* <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider">Amazon Web Services SDK for Go</a>
|
|
335
|
-
* </p>
|
|
336
|
-
* </li>
|
|
337
|
-
* <li>
|
|
338
|
-
* <p>
|
|
339
|
-
* <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html">Amazon Web Services SDK for Java V2</a>
|
|
340
|
-
* </p>
|
|
341
|
-
* </li>
|
|
342
|
-
* <li>
|
|
343
|
-
* <p>
|
|
344
|
-
* <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html">Amazon Web Services
|
|
345
|
-
* SDK for JavaScript</a>
|
|
346
|
-
* </p>
|
|
347
|
-
* </li>
|
|
348
|
-
* <li>
|
|
349
|
-
* <p>
|
|
350
|
-
* <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html">Amazon Web Services SDK for PHP
|
|
351
|
-
* V3</a>
|
|
352
|
-
* </p>
|
|
353
|
-
* </li>
|
|
354
|
-
* <li>
|
|
355
|
-
* <p>
|
|
356
|
-
* <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html">Amazon Web Services SDK for Python</a>
|
|
357
|
-
* </p>
|
|
358
|
-
* </li>
|
|
359
|
-
* <li>
|
|
360
|
-
* <p>
|
|
361
|
-
* <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html">Amazon Web Services SDK
|
|
362
|
-
* for Ruby V3</a>
|
|
363
|
-
* </p>
|
|
364
|
-
* </li>
|
|
365
|
-
* <li>
|
|
366
|
-
* <p>
|
|
367
|
-
* <a href="https://sdk.amazonaws.com/kotlin/api/latest/cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider/-cognito-identity-provider-client/index.html">Amazon Web Services SDK for Kotlin</a>
|
|
368
|
-
* </p>
|
|
369
|
-
* </li>
|
|
370
|
-
* </ul>
|
|
313
|
+
* with the <code>CognitoIdentityProvider</code> client in supported Amazon Web Services SDKs.</p>
|
|
371
314
|
* <p>To get started with an Amazon Web Services SDK, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>. For example actions and scenarios, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/service_code_examples_cognito-identity-provider.html">Code examples for Amazon Cognito Identity Provider using Amazon Web Services
|
|
372
315
|
* SDKs</a>.</p>
|
|
373
316
|
* @public
|
|
@@ -30,9 +30,6 @@ declare const AddCustomAttributesCommand_base: {
|
|
|
30
30
|
* <p>Adds additional user attributes to the user pool schema. Custom attributes can be
|
|
31
31
|
* mutable or immutable and have a <code>custom:</code> or <code>dev:</code> prefix. For
|
|
32
32
|
* more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-custom-attributes">Custom attributes</a>.</p>
|
|
33
|
-
* <p>You can also create custom attributes in the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html#CognitoUserPools-CreateUserPool-request-Schema">Schema parameter</a> of <code>CreateUserPool</code> and
|
|
34
|
-
* <code>UpdateUserPool</code>. You can't delete custom attributes after you
|
|
35
|
-
* create them.</p>
|
|
36
33
|
* <note>
|
|
37
34
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
38
35
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -27,8 +27,7 @@ declare const AdminConfirmSignUpCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Confirms user sign-up as an administrator.
|
|
31
|
-
* No confirmation code is required.</p>
|
|
30
|
+
* <p>Confirms user sign-up as an administrator. </p>
|
|
32
31
|
* <p>This request sets a user account active in a user pool that <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#signing-up-users-in-your-app-and-confirming-them-as-admin">requires confirmation of new user accounts</a> before they can sign in. You can
|
|
33
32
|
* configure your user pool to not send confirmation codes to new users and instead confirm
|
|
34
33
|
* them with this API operation on the back end.</p>
|
|
@@ -30,6 +30,18 @@ declare const AdminCreateUserCommand_base: {
|
|
|
30
30
|
* <p>Creates a new user in the specified user pool.</p>
|
|
31
31
|
* <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via
|
|
32
32
|
* email or phone (SMS).</p>
|
|
33
|
+
* <p>This message is based on a template that you configured in your call to create or
|
|
34
|
+
* update a user pool. This template includes your custom sign-up instructions and
|
|
35
|
+
* placeholders for user name and temporary password.</p>
|
|
36
|
+
* <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code>
|
|
37
|
+
* for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p>
|
|
38
|
+
* <p>In either case, if the user has a password, they will be in the
|
|
39
|
+
* <code>FORCE_CHANGE_PASSWORD</code> state until they sign in and set their password.
|
|
40
|
+
* Your invitation message template must have the <code>\{####\}</code> password placeholder
|
|
41
|
+
* if your users have passwords. If your template doesn't have this placeholder, Amazon Cognito
|
|
42
|
+
* doesn't deliver the invitation message. In this case, you must update your message
|
|
43
|
+
* template and resend the password with a new <code>AdminCreateUser</code> request with a
|
|
44
|
+
* <code>MessageAction</code> value of <code>RESEND</code>.</p>
|
|
33
45
|
* <note>
|
|
34
46
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
35
47
|
* require you to register an origination phone number before you can send SMS messages
|
|
@@ -47,18 +59,6 @@ declare const AdminCreateUserCommand_base: {
|
|
|
47
59
|
* of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
|
|
48
60
|
* Developer Guide</i>.</p>
|
|
49
61
|
* </note>
|
|
50
|
-
* <p>This message is based on a template that you configured in your call to create or
|
|
51
|
-
* update a user pool. This template includes your custom sign-up instructions and
|
|
52
|
-
* placeholders for user name and temporary password.</p>
|
|
53
|
-
* <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code>
|
|
54
|
-
* for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p>
|
|
55
|
-
* <p>In either case, if the user has a password, they will be in the
|
|
56
|
-
* <code>FORCE_CHANGE_PASSWORD</code> state until they sign in and set their password.
|
|
57
|
-
* Your invitation message template must have the <code>\{####\}</code> password placeholder
|
|
58
|
-
* if your users have passwords. If your template doesn't have this placeholder, Amazon Cognito
|
|
59
|
-
* doesn't deliver the invitation message. In this case, you must update your message
|
|
60
|
-
* template and resend the password with a new <code>AdminCreateUser</code> request with a
|
|
61
|
-
* <code>MessageAction</code> value of <code>RESEND</code>.</p>
|
|
62
62
|
* <note>
|
|
63
63
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
64
64
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -28,8 +28,8 @@ declare const AdminDeleteUserAttributesCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Deletes attribute values from a user. This operation doesn't affect tokens for
|
|
31
|
-
* existing user sessions. The next ID token that the user receives will no longer have
|
|
32
|
-
*
|
|
31
|
+
* existing user sessions. The next ID token that the user receives will no longer have the
|
|
32
|
+
* deleted attributes.</p>
|
|
33
33
|
* <note>
|
|
34
34
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
35
35
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -33,13 +33,11 @@ declare const AdminDisableProviderForUserCommand_base: {
|
|
|
33
33
|
* to deactivate is a linked external IdP user, any link between that user and an existing
|
|
34
34
|
* user is removed. When the external user signs in again, and the user is no longer
|
|
35
35
|
* attached to the previously linked <code>DestinationUser</code>, the user must create a
|
|
36
|
-
* new user account
|
|
37
|
-
* <p>The <code>ProviderName</code> must match the
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* <code>Cognito_Subject</code>. The <code>ProviderAttributeValue</code> must be the
|
|
42
|
-
* name that is used in the user pool for the user.</p>
|
|
36
|
+
* new user account.</p>
|
|
37
|
+
* <p>The value of <code>ProviderName</code> must match the name of a user pool IdP.</p>
|
|
38
|
+
* <p>To deactivate a local user, set <code>ProviderName</code> to <code>Cognito</code> and
|
|
39
|
+
* the <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>. The
|
|
40
|
+
* <code>ProviderAttributeValue</code> must be user's local username.</p>
|
|
43
41
|
* <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for
|
|
44
42
|
* social IdPs. The <code>ProviderAttributeValue</code> must always be the exact subject
|
|
45
43
|
* that was used when the user was originally linked as a source user.</p>
|
|
@@ -47,12 +45,11 @@ declare const AdminDisableProviderForUserCommand_base: {
|
|
|
47
45
|
* not yet been used to sign in, the <code>ProviderAttributeName</code> and
|
|
48
46
|
* <code>ProviderAttributeValue</code> must be the same values that were used for the
|
|
49
47
|
* <code>SourceUser</code> when the identities were originally linked using <code>
|
|
50
|
-
* AdminLinkProviderForUser</code> call.
|
|
51
|
-
* <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code
|
|
52
|
-
*
|
|
53
|
-
* <code>
|
|
54
|
-
* <code>
|
|
55
|
-
* assertion.</p>
|
|
48
|
+
* AdminLinkProviderForUser</code> call. This is also true if the linking was done with
|
|
49
|
+
* <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>. If the user
|
|
50
|
+
* has already signed in, the <code>ProviderAttributeName</code> must be
|
|
51
|
+
* <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code> must be the
|
|
52
|
+
* <code>NameID</code> from their SAML assertion.</p>
|
|
56
53
|
* <note>
|
|
57
54
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
58
55
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -27,7 +27,7 @@ declare const AdminEnableUserCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Activates sign-in for a user profile that previously had sign-in access
|
|
31
31
|
* disabled.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
@@ -27,7 +27,7 @@ declare const AdminGetDeviceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Given the device key, returns details for a user' device. For more information,
|
|
30
|
+
* <p>Given the device key, returns details for a user's device. For more information,
|
|
31
31
|
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with devices</a>.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
@@ -27,9 +27,10 @@ declare const AdminGetUserCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Given
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Given a username, returns details about a user profile in a user pool. You can specify
|
|
31
|
+
* alias attributes in the <code>Username</code> request parameter.</p>
|
|
32
|
+
* <p>This operation contributes to your monthly active user (MAU) count for the purpose of
|
|
33
|
+
* billing.</p>
|
|
33
34
|
* <note>
|
|
34
35
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
35
36
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -121,6 +121,9 @@ declare const AdminInitiateAuthCommand_base: {
|
|
|
121
121
|
* // DeviceGroupKey: "STRING_VALUE",
|
|
122
122
|
* // },
|
|
123
123
|
* // },
|
|
124
|
+
* // AvailableChallenges: [ // AvailableChallengeListType
|
|
125
|
+
* // "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",
|
|
126
|
+
* // ],
|
|
124
127
|
* // };
|
|
125
128
|
*
|
|
126
129
|
* ```
|
|
@@ -27,22 +27,21 @@ declare const AdminLinkProviderForUserCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Links an existing user account in a user pool
|
|
31
|
-
* identity from an external IdP
|
|
32
|
-
* name and value from the external IdP
|
|
33
|
-
*
|
|
34
|
-
* in
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* user identity, they sign in as the existing user account.</p>
|
|
30
|
+
* <p>Links an existing user account in a user pool, or <code>DestinationUser</code>, to an
|
|
31
|
+
* identity from an external IdP, or <code>SourceUser</code>, based on a specified
|
|
32
|
+
* attribute name and value from the external IdP.</p>
|
|
33
|
+
* <p>This operation connects a local user profile with a user identity who hasn't yet
|
|
34
|
+
* signed in from their third-party IdP. When the user signs in with their IdP, they get
|
|
35
|
+
* access-control configuration from the local user profile. Linked local users can also
|
|
36
|
+
* sign in with SDK-based API operations like <code>InitiateAuth</code> after they sign in
|
|
37
|
+
* at least once through their IdP. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html">Linking federated users</a>.</p>
|
|
39
38
|
* <note>
|
|
40
39
|
* <p>The maximum number of federated identities linked to a user is five.</p>
|
|
41
40
|
* </note>
|
|
42
41
|
* <important>
|
|
43
|
-
* <p>Because this API allows a user with an external federated identity to sign in as
|
|
44
|
-
*
|
|
45
|
-
*
|
|
42
|
+
* <p>Because this API allows a user with an external federated identity to sign in as a
|
|
43
|
+
* local user, it is critical that it only be used with external IdPs and linked
|
|
44
|
+
* attributes that you trust.</p>
|
|
46
45
|
* </important>
|
|
47
46
|
* <note>
|
|
48
47
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
@@ -27,7 +27,7 @@ declare const AdminRemoveUserFromGroupCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Given a username and a group name
|
|
30
|
+
* <p>Given a username and a group name, removes them from the group. User pool groups are
|
|
31
31
|
* identifiers that you can reference from the contents of ID and access tokens, and set
|
|
32
32
|
* preferred IAM roles for identity-pool authentication. For more information, 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>
|
|
33
33
|
* <note>
|
|
@@ -28,19 +28,9 @@ declare const AdminResetUserPasswordCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Resets the specified user's password in a user pool. This operation doesn't
|
|
31
|
-
* change the user's password, but sends a password-reset code
|
|
32
|
-
* administrative authentication API equivalent to <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html">ForgotPassword</a>.</p>
|
|
33
|
-
* <p>This operation deactivates a user's password, requiring them to change it. If a user
|
|
34
|
-
* tries to sign in after the API request, Amazon Cognito responds with a
|
|
35
|
-
* <code>PasswordResetRequiredException</code> error. Your app must then complete the
|
|
36
|
-
* forgot-password flow by prompting the user for their code and a new password, then
|
|
37
|
-
* submitting those values in a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html">ConfirmForgotPassword</a> request. In addition, if the user
|
|
38
|
-
* pool has phone verification selected and a verified phone number exists for the user, or
|
|
39
|
-
* if email verification is selected and a verified email exists for the user, calling this
|
|
40
|
-
* API will also result in sending a message to the end user with the code to change their
|
|
41
|
-
* password.</p>
|
|
31
|
+
* change the user's password, but sends a password-reset code.</p>
|
|
42
32
|
* <p>To use this API operation, your user pool must have self-service account recovery
|
|
43
|
-
* configured
|
|
33
|
+
* configured.</p>
|
|
44
34
|
* <note>
|
|
45
35
|
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
|
|
46
36
|
* require you to register an origination phone number before you can send SMS messages
|
|
@@ -32,9 +32,6 @@ declare const AdminSetUserMFAPreferenceCommand_base: {
|
|
|
32
32
|
* preferred. The preferred MFA factor will be used to authenticate a user if multiple
|
|
33
33
|
* factors are activated. If multiple options are activated and no preference is set, a
|
|
34
34
|
* challenge to choose an MFA option will be returned during sign-in.</p>
|
|
35
|
-
* <p>This operation doesn't reset an existing TOTP MFA for a user. To register a new
|
|
36
|
-
* 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,
|
|
37
|
-
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-totp.html">TOTP software token MFA</a>.</p>
|
|
38
35
|
* <note>
|
|
39
36
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
40
37
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -30,7 +30,7 @@ declare const AdminSetUserSettingsCommand_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 MFA
|
|
33
|
+
* token MFA.</p>
|
|
34
34
|
* <note>
|
|
35
35
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
36
36
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
@@ -27,13 +27,16 @@ declare const AdminUpdateAuthEventFeedbackCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Provides feedback for an authentication event
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
30
|
+
* <p>Provides the feedback for an authentication event generated by threat protection
|
|
31
|
+
* features. Your response indicates that you think that the event either was from a valid
|
|
32
|
+
* 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>To train the threat-protection model to recognize trusted and untrusted sign-in
|
|
37
|
+
* characteristics, configure threat protection in audit-only mode and provide a mechanism
|
|
38
|
+
* for users or administrators to submit feedback. Your feedback can tell Amazon Cognito that a risk
|
|
39
|
+
* rating was assigned at a level you don't agree with.</p>
|
|
37
40
|
* <note>
|
|
38
41
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
39
42
|
* this operation, you must use IAM credentials to authorize requests, and you must
|