Login with Google

Overview

Google Sign-In can be used to authenticate users, or create new users based on their email address.

Here's how it works:

  1. User clicks the login button, sending a request to /auth/google with client_id and redirect_uri
  2. Transmit redirects to the Google login page, which authenticates the user and redirects back to Transmit.
  3. After validating the response, Transmit redirects back to your redirect_uri with a code.
  4. Your application sends the code to your backend, which exchanges it for token.
  5. Upon a successful exchange, the user is logged in.

Step 1: Set up Google Project

Follow the Get your Google API client guide to get your Google client_id and client_secret. You will also need to set your redirect URI to https://api.transmitsecurity.io/cis/auth/google/callback.

For more details on how to create a new project, click here

Step 2: Configure consent screen

The Google consent screen tells users that the application is requesting access to their data, what kind of data, and the terms that apply.

  1. Open the OAuth consent screen page of the Google API console.
  2. If prompted, select the project you just created.
  3. Select User Type (described below) and click Create .

User Types

Internal means your app is limited to Google Workspace users within your Google workspace. You can communicate with your internal users directly about how you'll use their data. In order to choose ‘Internal’ your project must be part of Google Workspace.

External means your app will only be available to users you add to the list of test users. Once your app is ready to publish, you may need to verify your app. In most cases, you will need to choose external.

Learn more about user type

  1. Fill in your application data.
  2. Click Save and continue in the scopes and test user screens without any changes.
Note

To move to In Production status, you're required to verify your app. Learn more

Step 3: Enable Google for app

  1. Login to the Transmit Admin Portal
  2. Go to Manage Experience > Authentication
  3. Expand the Google settings.
  4. Fill in the client ID and client secret retrieved from Google in Step 1

Step 4: Add redirect URI to app

To redirect back to the redirect_uri provided in the initial request, it should be registered in your application settings in Transmit Admin Portal. From the Admin Portal under Applications, click on your application to edit your application settings and add this URI under Redirect URIs. If you don't already have an application, you'll need to create one first (see Create application).

Note

Your application settings contain the Client ID and Client Secret for your application, which you'll need for Step 5 and 6.

Step 5: Initiate Google login

Use a request like the one below to initiate an authentication flow using Google, described in the sequence diagram above. The create_new_user parameter will determine if this flow applies to new users, or only to existing ones. If set to true (and public sign-ups are enabled for this application), a new user is created if no user is found for the email returned by Google in the next step. The redirect_uri should correspond to the one added in step 4, and the client_id can be found from the Transmit Admin Portal in the application settings.

Note

Upon successful authentication, the browser will be redirected to the redirect URI along with a code to exchange for tokens in the next step. For example, if https://domain.com/verify is your redirect URI, then Transmit will redirect to https://domain.com/verify?code=123abc. However, if an authentication error occurs after redirecting to Google, the redirect URI will contain the error instead.

Copy
Copied
curl --request GET \
     --url 'https://api.transmitsecurity.io/cis/v1/auth/google?
     client_id=2eb840f.test.Transmit.io&
     redirect_uri=https://www.example.com/login&
     create_new_user=true' \
     --header 'Accept: application/json'

Step 6: Get user tokens

To exchange the code received from Transmit for an ID and access token, your server should send a POST request like the one below to the Transmit /oidc/token endpoint. Replace placeholders with the code you received in Step 5, your redirect URI, and your client credentials that can be found in your application settings from the Transmit Admin Portal.

Copy
Copied
curl -i -X POST \
  https://api.transmitsecurity.io/oidc/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d client_id=CLIENT_ID \
  -d client_secret=CLIENT_SECRET \
  -d code=CODE \
  -d grant_type=authorization_code \
  -d redirect_uri=REDIRECT_URI