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.
Container for the parameters to the AdminLinkProviderForUser operation.
Links an existing user account in a user pool (DestinationUser
) to an identity
from an external IdP (SourceUser
) based on a specified attribute name and value
from the external IdP. 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. You
can then use the federated user identity 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. When the user signs in with a federated user identity, they sign in as the existing user account.
The maximum number of federated identities linked to a user is five.
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 IdPs and provider attributes that have been trusted by the application owner.
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
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class AdminLinkProviderForUserRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminLinkProviderForUserRequest type exposes the following members
Name | Description | |
---|---|---|
AdminLinkProviderForUserRequest() |
Name | Type | Description | |
---|---|---|---|
DestinationUser | Amazon.CognitoIdentityProvider.Model.ProviderUserIdentifierType |
Gets and sets the property DestinationUser. The existing user in the user pool that you want to assign to the external IdP user account. This user can be a local (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.
For a native username + password user, the
The
The All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed. |
|
SourceUser | Amazon.CognitoIdentityProvider.Model.ProviderUserIdentifierType |
Gets and sets the property SourceUser. An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.
If the
For OIDC, the
For SAML, the
For both OIDC and SAML users, when you set |
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The user pool ID for the user pool. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5