/

POST

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.

This action is administrative and requires developer credentials.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "DestinationUser": {
        "ProviderName": "string",
        "ProviderAttributeName": "string",
        "ProviderAttributeValue": "string"
    },
    "SourceUser": {}
}'

Response Example

200 - Example 1

{}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482TooManyRequestsException

🟠483NotAuthorizedException

🟠484UserNotFoundException

🟠485AliasExistsException

🟠486LimitExceededException

🟠487InternalErrorException

Modified at 2023-08-15 07:11:06