Integrate OpenPass with Google Cloud Platform
OpenPass provides authentication services based on the OpenID Connect framework. Since we adhere to this standard, OpenPass can be configured as a sign-in option on many cloud-based identity solution providers. One such provider, Google Cloud Platform (GCP), allows users to connect to external OpenID Connect providers, like OpenPass.
Once you have established the connection, you can activate the OpenPass connection for your applications in your GCP domain, enabling organizations to quickly onboard and use OpenPass as an identity solution option.
You can integrate OpenPass with GCP by using a custom OIDC integration. Here is an overview of the steps needed to integrate OpenPass with GCP:
- Configure a new OIDC provider in Google Cloud Identity Platform. Make sure you have registered for a GCP account first.
- To get the client ID and secret, register your application in OpenPass.
- Complete the setup in Google Cloud Identity Platform by entering the client ID and secret you received from OpenPass.
- Use the Firebase console to authenticate with the new identity provider for your application.
The following sections provide more details for each step.
NOTE: The following instructions that rely on third-party UI are current as of February 27, 2024.
1. Configure a new OIDC provider
IMPORTANT: Make sure you have registered for a GCP account first.
To create a new OIDC provider, do the following:
| Step | Description | Notes |
|---|---|---|
| 1 | In the GCP console, go to the Identity Platform Marketplace page. | N/A |
| 2 | In the Identity Platform page, click Enable Identity Platform. | IMPORTANT: Be sure to enable the identity platform for your current project. The current project is displayed in the dropdown menu at the top-left corner of the page. Enabling this option will determine some of the configuration for the identity provider. |
| 3 | Near the top of the Identity Providers page, click Add a provider. | N/A |
| 4 | In the Sign-In Method page, from the Select a provider dropdown menu, select OpenID Connect. Then configure the following:
|
IMPORTANT: Skip the Client ID and Client Secret fields for now. After registering with OpenPass, you will obtain the client ID and secret, which you can then enter in this form. |
| 5 | Copy the URL in the Authorization callback (URL) field. | This URL is needed to configure the client entry in OpenPass. |
This completes the configuration for the new OIDC provider.
2. Register the application in OpenPass
To register your application with OpenPass, complete the OpenPass application-registration form. If you do not have an account in the OpenPass self-service portal, email support@myopenpass.com to get an account created.
The following is the minimum information to get a client registered.
| Field | Notes |
|---|---|
| Full name | Enter the name of the contact for your organization. |
| Client Name | This is the name that will be displayed in the UI experience, if any. |
| Logo | This is the logo of the application you are integrating in GCP. |
| Friendly Website URL | The URL of the application you are integrating in GCP. |
| Redirect URLs | Paste the authentication callback URL that you copied from the GCP console. |
| Link to your privacy statement | This is recommended to be displayed to the user during sign-in. |
| Link to your Terms of Service | This is recommended to be displayed to the user during sign-in. |
The client ID and secret will be emailed to you by the OpenPass team.
3. Complete setup in Google cloud identity platform
In the GCP Identity Provider configuration page, enter the client ID and client secret in their respective fields and click Save.
This completes the setup for the GCP identity provider.
4. Use the firebase console to authenticate with the new identity provider
Consumer-facing, scalable applications are usually hosted in Google Firebase. In the Firebase console, enable the newly configured identity provider for your application.
| Step | Description |
|---|---|
| 1 | In the Firebase console, go to the Authentication section for your current project, then click the Sign-in method tab. |
| 2 | In the Custom providers section, click OpenID Connect. |
| 3 | In the OpenID Connect section, click Enable to activate the fields in the form. Complete the following fields:
|
| 4 | In the Configure OIDC Integration section, follow the instructions for your type of platform (Apple, Android, or Web). When done, click Save. |
Setting up your application in Firebase completes the integration.
Additional resources
For more information, see the following pages:
- Signing In Users with OIDC
- Quickstart guides
- Security considerations
- Authentication tokens
- UID2
- Integration best practices
- Co-branding guidelines