AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Prevents the user from signing in with the specified external (SAML or social) identity
provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools
native username + password user, they can't use their password to sign in. If the
user to deactivate is a linked external IdP user, any link between that user and an
existing user is removed. When the external user signs in again, and the user is no
longer attached to the previously linked DestinationUser, the user must create
a new user account.
The value of ProviderName must match the name of a user pool IdP.
To deactivate a local user, set ProviderName to Cognito and the ProviderAttributeName
to Cognito_Subject. The ProviderAttributeValue must be user's local
username.
The ProviderAttributeName must always be Cognito_Subject for social
IdPs. The ProviderAttributeValue must always be the exact subject that was
used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has
not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue
must be the same values that were used for the SourceUser when the identities
were originally linked using AdminLinkProviderForUser call. This is also true
if the linking was done with ProviderAttributeName set to Cognito_Subject.
If the user has already signed in, the ProviderAttributeName must be Cognito_Subject
and ProviderAttributeValue must be the NameID from their SAML assertion.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginAdminDisableProviderForUser and EndAdminDisableProviderForUser.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual Task<AdminDisableProviderForUserResponse> AdminDisableProviderForUserAsync( AdminDisableProviderForUserRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the AdminDisableProviderForUser service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AliasExistsException | This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias. |
| InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
| InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
| NotAuthorizedException | This exception is thrown when a user isn't authorized. |
| ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
| TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
| UserNotFoundException | This exception is thrown when a user isn't found. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer