Skip to main content

Google OAuth

Creating a custom Google OAuth application​

Step-by-step instructions below follow Google's documentation on setting up OAuth 2.0 for a web application.

Build the consent screen​

  1. Create or select a project on the Google Cloud Platform Console.
  2. Navigate to the project's OAuth consent screen.
  3. Select whether your application is an internal or external app.
  4. Fill out the application name and support email.
  5. Add additional scopes required by your application, saving the full scope URI for later.
  6. Ensure that the email and profile scopes are still selected.
  7. Under Authorized domains, add ngrok.com and your application homepage domain.
  8. Add links to your application homepage and privacy policy. The final consent screen should resemble:
  9. Save the application.
    • Applications that require verification cannot complete the consent screen and are not supported by ngrok.

Create credentials for ngrok​

  1. Navigate to Credentials for your project.
  2. Select "Create credentials" from the top menu and select "OAuth Client ID".
  3. Choose "Web application" from the list of application types.
  4. Name your secret, then set "Authorized Redirect URIs" to https://idp.ngrok.com/oauth2/callback. The final credentials form should resemble:
  5. Securely store the client ID and secret from the final screen:

Update your endpoint configuration​

  1. Return to the ngrok dashboard and create or edit an OAuth endpoint configuration module for your edge.
  2. Choose to use your own application with Google as the provider.
  3. Include the client ID, secret, and scopes configured in your application.
  4. Add the following scopes to your application if they are not already present:
    • https://www.googleapis.com/auth/userinfo.profile
    • https://www.googleapis.com/auth/userinfo.email

Additional application setup information​