Catalyst Docs

Before you enable Social Logins while setting up an authentication method, you must complete certain steps to ensure you have the required Client ID and Client Secret for each service that you require. This involves configuring an app in the respective social login’s developer console, and fetching the OAuth credentials. You will also need to have your own account with each of the Social Login providers to access their developer consoles.

Note: Public Signup must be enabled to use Social Logins.

Enable Zoho Social Login

Because you are building application on Catalyst, you do not have to create an OAuth Client ID and Client Secret to enable Zoho sign in. You can easily enable the Zoho social login in this way:

Click the Zoho social login option while setting up the authentication, and enter the name of your application as the client name
Click Enable to implement user sign ups using Zoho social login.

Your end users can now sign up to your application using their Zoho credentials.

Enable Google Social Login

To enable Google sign in option in your application, you must obtain the required OAuth credentials for your application from Google in the following manner:

Login to the Google API Console and click Create Project.
Click New Project.

Note: If you had already created a project in the Google developer console for your application, select your existing project. Skip the next step for an existing project.

Enter the required information and click Create.
After the project has been created, navigate to the Credentials page. You will be asked to configure the OAuth consent screen with your application details, if it is a new project. Click Configure Consent Screen.

Note: If this is not a new project, you can modify some information about your application. Navigate to the OAuth consent screen page. Click EDIT APP, then follow the steps below.

Choose a user type for your app and click Create.
Provide the required information.
In the App domain section, under the Application home page section provide your applications home page. Enter the other information as required and click Save And Continue.
In the Scopes section, click Edit, if you wish to add or manage scopes other than the default section.
Select the scopes you require from the options listed. You can also manually provide the applicable scopes in the Manually add scopes section, and click UPDATE. Click SAVE AND CONTINUE once you have configured the scopes.
In the Summary section, confirm your configurations and click the Edit button should you need to edit any of the configuration.
Navigate back to the Credentials page and click Create Credentials. Select OAuth client ID from the drop-down list.
Select Web application as the type of your application your app is going to be from the drop-down selection of Application type.

Note: Even if you host your application as an Android app, iOS, or a Flutter app, the Client ID and Client Secret to enable the social login will be the same, and can be obtained by choosing the application type as Web application.

Enter the name of your application.
Click ADD URI under Authorised JavaScript origins and Click ADD URI under Authorised redirect URIs and enter the redirect URIs of your application in the following format:
- https://accounts.zohoportal.com/accounts/extoauth/ZAID/clientcallback
- https://{{appdomain}}/accounts/pfs/ZAID/clientidpcallback
  This URI can be copied from the Google Social Login pop-up, and steps to enable this URI is shown in this help document:

Note: The ZAID value can be obtained from the Google Social Login pop-up. However, to ensure that the Social Logins are enabled when you migrate your app to production, you need to reconfigure them using the Production ZAID, and the appropriate app domain.

catalyst_authentication_google_social_login_uris

Click Create, once you have added the required information.

You will now be directed to pop up displaying the Client ID and Client Secret. You can copy the values and download the JSON file containing the same.

Now, click the Google social login present in the Catalyst console and enter the Client ID and Client Secret you copied from the Google console, and click Enable.
Your end users can now sign up to your application using their Google credentials.

Enable Facebook Social Login

To enable Facebook sign in option in your application you need to obtain the required OAuth credentials for your application from Facebook in the following manner:

Open the Facebook developer page: Meta Developer Console
Log in to Facebook, and click the My Apps option.
Click on Create App
Select the “Authenticate and request data from users with Facebook Login” and click Next.
Select the “No, I’m not building a game option” and click Next.
Enter the required details and click Create App.
You will now be directed to the Dashboard of the Facebook developer console. Select the “Customize adding a Facebook Login button” option.
Click the “Go to quickstart” button.
Select Web as your app platform.

Note: Even if you wish to host your application as Android, iOS, or a Flutter app, select Web as the platform type, as the Client ID and Client Secret do not change.

Enter your application’s url in the Site URL input field, and click Save.
The rest of the steps mentioned in this page are not mandatory. You can skip them or configure them if your application requires it. Click the “Go back” button.
Click the “Go to Settings” option to configure the OAuth Redirect URIs.
Choose the provided options per your preference.
In the Valid OAuth Redirect URIs input field section, provide the OAuth Redirect URIs in the following format:

https://accounts.zohoportal.com/accounts/extoauth/ZAID/clientcallback
https://{{appdomain}}/accounts/pfs/ZAID/clientidpcallback

This URI can be copied from the Facebook Social Login pop-up, and steps to enable this URI is shown in this help document: cloud_scale_social_login_facebook_configure_authorized_uri

Note: The ZAID value can be obtained from the Facebook Social Login pop-up. However, to ensure that the Social Logins are enabled when you migrate your app to production, you need to reconfigure them using the Production ZAID, and the appropriate app domain.

catalyst_authentication_fb_social_login_authorizeduris

Click the “Add” button present in the Permissions section to allow Facebook to share the credentials of the users that choose to login to your application using Facebook.
Click the “Go back” button, and you will be directed to the Dashboard.
Now select the “Basic” option present in the App Settings section of the console, and copy and save the Client ID and Client Secret details generated by Facebook. Click Save Changes once you have completed reviewing the details.
You can now enable the Facebook Social Login in the console. Click the Facebook option and paste the App ID value in the Client ID field and the App Secret value in the Client Secret field, and click Enable.

Your end users can will now be able to sign up to your application using their Facebook credentials.

Enable LinkedIn Social Login

To enable LinkedIn sign in option in your application you need to obtain the required OAuth credentials for your application from LinkedIn in the following manner:

Note:

Before you implement the following steps, ensure you have created a LinkedIn page to represent your company or organization. This page is mandatory to configure LinkedIn social login.
LinkedIn uses OpenID Connect protocols and not OAuth protocols. For more information on this update, visit LinkedIn’s documentation page

Login to the LinkedIn developer page: http://developer.linkedin.com
Click the Create App button in the center of the page.

Note: You can also navigate to the My Apps section present in the taskbar and click Create App.

Enter the required information, such as the app name, privacy policy URL, and the app’s logo.

Note: If you have not created a LinkedIn page for your application, you can do so now by clicking the +Create a new LinkedIn Page button.

Agree to the terms and conditions and click Create app.
Now verify your application by clicking the Verify button that appears next to your application’s LinkedIn page.

Click Generate URL to generate verification URL.
Complete the verification process, and click I’m done.

In the Settings section, add your application URL to the Domain input field of the Widgets section if necessary.
Navigate to the Products tab, select “Sign in with LinkedIn Using OpenID Connect”, and click Request Access.
Read and accept the terms and conditions, click the Request Access button to allow sign ups with LinkedIn using OpenID connect.
Click the Auth tab, and copy the Client ID and Client Secret present in the Authentication keys section. In the OAuth 2.0 scopes section you will be able to view three scopes have been added:

openid
profile
email

Now click the Auth tab, and copy the Client ID and Client Secret present in the Authentication keys section. In the Auth 2.0 settings section add Authorized Redirection URLs of your application in the following format:
- https://accounts.zohoportal.com/accounts/extoauth/ZAID/clientcallback
- https://{{appdomain}}/accounts/pfs/ZAID/clientidpcallback
  This URI can be copied from the LinkedIn Social Login pop-up, and steps to enable this URI is shown in this help document:

Note: The ZAID value can be obtained from the LinkedIn Social Login pop-up. However, to ensure that the Social Logins are enabled when you migrate your app to production, you need to reconfigure them using the Production ZAID, and the appropriate app domain.

catalyst_authentication_linkein_social_login_idnsecrt

Click the LinkedIn Social Login option present in the console, and add the Client ID and Client Secret obtained. Then, click Enable.

Your end users can now sign up to your application using their LinkedIn credentials.

Enable Microsoft 365 Social Login

To enable Microsoft 365 sign in option in your application you will need to obtain the requisite OAuth credentials for your application with Microsoft Azure in the following manner:

Open Microsoft Azure and login to the console.
Navigate to the menu section of the console and click App Registrations.
Click New Registration.
Enter the application name, choose the required permission. In the Redirect URI section, choose Web and enter the URI in the following format:
https://{{appdomain}}/accounts/pfs/ZAID/clientidpcallback
This URI can be copied from the Microsoft 365 Social Login pop-up, and steps to enable this URI is shown in this help document:

Note: The ZAID value can be obtained from the Microsoft 365 Social Login pop-up. However, to ensure that the Social Logins are enabled when you migrate your app to production, you need to reconfigure them using the Production ZAID, and the appropriate app domain.

catalyst_authentication_microsoft_social_login_register_highlight

Note: You will have to add the second URI in a later step.

You will now be directed to the Overview section. Here you can copy the Application ID (Client ID).

catalyst_authentication_microsoft_social_login_clientid_highlight

Click the Redirect URIs section.

catalyst_authentication_microsoft_social_login_redirect_highlight

In the Redirect URI section, click Add URI and add the second URI in the following format:https://accounts.zohoportal.com/accounts/extoauth/ZAID/clientcallback

catalyst_authentication_microsoft_social_login_redirecturi

Now, navigate to the Certificates & secrets section from the menu-bar, and click the Client secrets section.
Click New Client Secret, to generate Client Secret.
Enter the required details and click Add.
Copy the Secret ID (Client Secret) value.
Click the Microsoft 365 Social Login option present in the console and add the Client ID and Client Secret obtained and click Enable.