Container for the parameters to the AdminLinkProviderForUser operation.
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.
public class AdminLinkProviderForUserRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminLinkProviderForUserRequest type exposes the following members
Gets and sets the property DestinationUser.
The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in.
Gets and sets the property SourceUser.
An external identity provider account for a user who does not currently exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.
For SAML, the
Gets and sets the property UserPoolId.
The user pool ID for the user pool.
Supported in: 1.3
Supported in: 4.5, 4.0, 3.5
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms