... endpoint

Description of changes

Files changed

The following files had changes:

• packages/auth/src/types/OAuth.ts
• packages/auth/src/Auth.ts
• packages/auth/src/OAuth/OAuth.ts

Changes

The packages/auth/src/types/OAuth.ts file had the following changes:

An idpIdentifierfiled was added as an optional field in the FederatedSignInOptions and FederatedSignInOptionsCustom types to enable the idp_identifier query parameter when sending the request URL to the Cognito authorize endpoint. Additionally, a hasIdpIdentifier function was added to evaluate if the provider options have an idpIdentifier key. Also, the provider field was made optional, as either an idp_identifier or a provider is used when requesting for an IdP, as described in the Amazon Cognito documentation.

The packages/auth/src/Auth.ts file had the following changes:

The hasIdpIdentifier function was used to check for the idpIdentifier key. In case it has it, the idpIdentifier value is extracted either from the FederatedSignInOptions type or the FederatedSignInOptions type. After that the idpIdentifier is passed to the this._oAuthHandler.oauthSignIn function.

Finally, the packages/auth/src/OAuth/OAuth.ts file had the following changes:

The function oauthSignIn was modified to make the provider argument optional and added an optional argument idpIdentifier. In case there is a provider present the request URL generated will send the provider as the identity_provider query parameter and ignore any idpIdentifier present, as either an idp_identifier or an identity_provider is used when requesting for an IdP. In case there is no provider, it will check for the idpIdentifier and send it as the idp_identifier query parameter in the Cognito authorize endpoint.

Issue #, if available

Closes #10226

Description of how you validated changes

I created a sample React app with the following component:

import { Auth } from "aws-amplify";
import { useEffect, useState } from "react";
export default function SignInPage() {
 const [user, setUser] = useState(null);
 const signIn = async () => {
 try {
 await Auth.federatedSignIn({
 idpIdentifier: "hotmail.com", // IdP identifier which was set up via amazon cognito
 });
 } catch (error) {
 console.log("error signing in", error);
 }
 };
 useEffect(() => {
 getUser().then((userData) => setUser(userData));
 }, []);
 function getUser() {
 return Auth.currentAuthenticatedUser()
 .then((userData) => userData)
 .catch(() => console.log("Not signed in"));
 }
 return (
 <div>
 <h1>
 Welcome{" "}
 {user ? JSON.stringify(user.attributes.email) : "Ups! Not signed in"}
 </h1>
 {user ? (
 <button onClick={() => Auth.signOut()}>Sign Out</button>
 ) : (
 <button onClick={signIn}>Federated Sign In</button>
 )}
 </div>
 );
}

The federate sign in identity was set up as described in the comment in #10226 and adding an IdPidentifier as shown below:
image

The app successfully logged in the user and added it to the cognito user pool created.

Previous test cases when using default options or no arguments for the federatedSignin function where tested and they worked correctly.

Checklist

• PR description included
• yarn test passes (It is not working for @aws-amplify/storage tests in the latest branch)
• yarn run test --scope @aws-amplify/auth passes
• Tests are changed or added
• Relevant documentation is changed or added (and PR referenced)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.