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.
Disables the user from signing in with the specified external (SAML or social) identity
provider. If the user to disable is a Cognito User Pools native username + password
user, they are not permitted to use their password to sign-in. If the user to disable
is a linked external IdP user, any link between that user and an existing user is
removed. The next time the external user (no longer attached to the previously linked
DestinationUser) signs in, they must create a new user account. See AdminLinkProviderForUser.
This action is enabled only for admin access and requires developer credentials.
ProviderName must match the value specified when creating an IdP
for the pool.
To disable a native username + password user, the
Cognito and the
ProviderAttributeName must be
ProviderAttributeValue being the name that is used in the user
pool for the user.
ProviderAttributeName must always be
for social identity providers. The
ProviderAttributeValue must always
be the exact subject that was used when the user was originally linked as a source
For de-linking a SAML identity, there are two scenarios. If the linked identity has
not yet been used to sign-in, the
must be the same values that were used for the
SourceUser when the identities
were originally linked in the AdminLinkProviderForUser
call. (If the linking was done with
ProviderAttributeName set to
the same applies here). However, if the user has already signed in, the
be the subject of the SAML assertion.
For PCL this operation is only available in asynchronous form. Please refer to AdminDisableProviderForUserAsync.
public abstract AdminDisableProviderForUserResponse AdminDisableProviderForUser( AdminDisableProviderForUserRequest request )
Container for the necessary parameters to execute the AdminDisableProviderForUser service method.
|AliasExistsException||This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.|
|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 is not authorized.|
|ResourceNotFoundException||This exception is thrown when the Amazon Cognito service cannot 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 is not found.|
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms