2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								---
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								title: Google SSO
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								slug: /security/google
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								collate: true
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								---
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								# Google SSO
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								Follow the sections in this guide to set up Google SSO.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								{% note %}
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								Security requirements for your **production** environment:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- **DELETE** the admin default account shipped by OM in case you had [Basic Authentication](/deployment/security/basic-auth)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  enabled before configuring the authentication with Google SSO.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- **UPDATE** the Private / Public keys used for the [JWT Tokens](/deployment/security/enable-jwt-tokens). The keys we provide
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  by default are aimed only for quickstart and testing purposes. They should NEVER be used in a production installation.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								{% /note %}
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								## Create Server Credentials
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								### Step 1: Create the Account
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Go to [Create Google Cloud Account](https://console.cloud.google.com/)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Click on `Create Project`
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/create-account.png" alt="create-account" caption="Create a New Account" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								### Step 2: Create a New Project
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								Enter the **Project name**.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								Enter the parent organization or folder in the **Location box**. That resource will be the hierarchical parent of the new project.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								Click **Create**.
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/create-project.png" alt="create-project" caption="Create a New Project" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								### Step 3: How to Configure OAuth Consent
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Select the project you created above and click on **APIs & Services** on the left-side panel.
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/configure-oauth-consent.png" alt="configure-oauth-consent" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Click on the **OAuth Consent Screen** available on the left-hand side panel.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Choose User Type **Internal**.
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/select-user-type.png" alt="select-user-type" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Once the user type is selected, provide the **App Information** and other details.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Click **Save and Continue**.
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/save-app-information.png" alt="save-app-information" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- On the **Scopes Screen**, Click on **ADD OR REMOVE SCOPES** and select the scopes.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Once done click on **Update**.
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/scopes-screen.png" alt="scopes-screen" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Click **Save and Continue**.
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/save-edit-app-registration.png" alt="save-edit-app-registration" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Click on **Back to Dashboard**.
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/back-to-dashboard.png" alt="back-to-dashboard" /%}
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/back-to-dashboard-2.png" alt="back-to-dashboard" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								### Step 4: Create Credentials for the Project
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Once the OAuth Consent is configured, click on **Credentials** available on the left-hand side panel.
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/create-credentials.png" alt="create-credentials" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Click on **Create Credentials**
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Select **OAuth client ID** from the dropdown.
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/select-outh-client-id.png" alt="cselect-outh-client-id" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Once selected, you will be asked to select the **Application type**. Select **Web application**.
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/select-web-application.png" alt="select-web-application" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								After selecting the **Application Type**, name your project and give the authorized URIs:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  - domain/callback
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  - domain/silent-callback
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/authorized-urls.png" alt="authorized-urls" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Click **Create**
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- You will get the credentials
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/get-the-credentials.png" alt="get-the-credentials" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								### Step 5: Where to Find the Credentials
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Go to **Credentials**
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Click on the **pencil icon (Edit OAuth Client)** on the right side of the screen
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/find-credentials.png" alt="find-credentials" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- You will find the **Client ID** in the top right corner
							 | 
						
					
						
							
								
									
										
										
										
											2024-12-12 11:34:09 +05:30
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								{% image src="/images/v1.7/deployment/security/google/find-clientid-and-secret.png" alt="find-clientid-and-secret" /%}
							 | 
						
					
						
							
								
									
										
										
										
											2024-09-02 09:29:06 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								You will need to share the following information with the Collate team:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								- Client ID
							 |