Smaws_Client_CognitoIdentityProvider.AdminLinkProviderForUserLinks an existing user account in a user pool, or DestinationUser, to an identity from an external IdP, or SourceUser, based on a specified attribute name and value from the external IdP.
This operation connects a local user profile with a user identity who hasn't yet signed in from their third-party IdP. When the user signs in with their IdP, they get access-control configuration from the local user profile. Linked local users can also sign in with SDK-based API operations like InitiateAuth after they sign in at least once through their IdP. For more information, see Linking federated users.
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 a local user, it is critical that it only be used with external IdPs and linked attributes that you trust.
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
val error_to_string :
[ Smaws_Lib.Protocols.AwsJson.error
| `AliasExistsException of Types.alias_exists_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `LimitExceededException of Types.limit_exceeded_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UserNotFoundException of Types.user_not_found_exception ] ->
stringval request :
'http_type Smaws_Lib.Context.t ->
Types.admin_link_provider_for_user_request ->
(Types.admin_link_provider_for_user_response,
[> Smaws_Lib.Protocols.AwsJson.error
| `AliasExistsException of Types.alias_exists_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `LimitExceededException of Types.limit_exceeded_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UserNotFoundException of Types.user_not_found_exception ])
Stdlib.resultval request_with_metadata :
'http_type Smaws_Lib.Context.t ->
Types.admin_link_provider_for_user_request ->
(Types.admin_link_provider_for_user_response Smaws_Lib.Response.t,
[> Smaws_Lib.Protocols.AwsJson.error
| `AliasExistsException of Types.alias_exists_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `LimitExceededException of Types.limit_exceeded_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UserNotFoundException of Types.user_not_found_exception ]
* Smaws_Lib.Response.metadata)
Stdlib.result