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.
Links an existing user account in a user pool (
DestinationUser) to an
identity from an external identity provider (
SourceUser) based on a specified
attribute name and value from the external identity provider. This allows you to create
a link from the existing user account to an external federated user identity that
has not yet been used to sign in, so that the federated user identity can be used
to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.
See also AdminDisableProviderForUser.
This action is enabled only for admin access and requires developer credentials.
For PCL this operation is only available in asynchronous form. Please refer to AdminLinkProviderForUserAsync.
public virtual AdminLinkProviderForUserResponse AdminLinkProviderForUser( AdminLinkProviderForUserRequest request )
Container for the necessary parameters to execute the AdminLinkProviderForUser 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