Skip to content

Google OAuth ​

Plane already ships with out-of-the-box support for Google OAuth. This is the easiest option to configure for Google Workspace users.

Configure Plane as an app on Google API Console ​

First, you will need to identify Plane as an approved OAuth app to Google.

  1. Go to the Google API console and create a new project.

  2. Navigate to the OAuth consent screen under APIs & Services. Choose how you want to configure and register the Plane app, including your target users, and click Create.

    Google Cloud Platform APIs & Services with OAuth consent screen selected in the sidebar, the User Type choice between Internal for users within your organization and External for any user with a Google Account, and a Create button

  3. Configure the OAuth consent screen with information about the app.

    Google Cloud Platform OAuth consent screen form with Verification status Not published, empty Application name and Application logo fields, a redacted Support email, the email, profile and openid scopes with an Add scope button, and an Authorized domains field

  4. Navigate to the Credentials screen, click Create Credentials, and select OAuth client ID from the options given.

    Google Cloud Platform Credentials page with the Create credentials menu open, listing API key, OAuth client ID, Service account and Help me choose, above the empty API Keys, OAuth 2.0 Client IDs and Service Accounts lists

  5. Select Web application under the Application type dropdown list. Update the following fields.

    1. Authorized JavaScript origins
      The HTTP origins that host your web application, e.g., https://app.plane.so
    2. Authorized redirect URIs
      Append the path that users should be redirected to after they have authenticated with Google. https://<plane.example.com>/auth/google/callback and https://<plane.example.com>/auth/mobile/google/callback/ where <plane.example.com> is your self-hosted instance's domain.
    3. Click Create.
    4. Get the Client ID and Client secret under OAuth 2.0 Client IDs on the Credentials screen.

Configure Plane ​

Google settings in God mode with a Client ID and a masked Client secret, next to the Plane-provided Origin URL and the web and mobile Callback URIs for https://plane.acme.test

  1. Go to Google on the Authentication screen of /god mode.
  2. Add the client ID + the client secret from Google API Console.
  3. Click Save .

Your Plane instance should now work with Sign in with Google.

INFO

We don't restrict domains in with Google OAuth yet. It's on our roadmap.