Single sign-on · Setup guides

Google Workspace

Set up a custom SAML application in Google Workspace and connect it to OrbitID. You need a Google Workspace admin account.

Step 1: Create application

From your Google Admin console, click Apps from the sidebar then click Web and mobile apps from the list.

If your application is already created, choose it from the list and move to the next step.

If you haven't created a SAML application, click Add custom SAML app from the Add app menu.

Web and mobile apps page with Add custom SAML app highlighted

Give your application an App name and click Continue.

App details step with the app name field

Step 2: Configure application

From the next screen, click DOWNLOAD METADATA to download the metadata XML file, then click Continue. You will paste this file into OrbitID at the end.

Google Identity Provider details with the download metadata button

Enter the following values in the Service provider details section:

ACS URL
https://app.orbitid.com/api/oauth/saml
The ACS URL shown in your OrbitID Configuration page. Sandbox uses https://app.orbitid.com/api/oauth/sandbox/saml.
Entity ID
https://saml.orbitid.com
The SP Entity ID shown in your OrbitID Configuration page. Sandbox uses https://saml.orbitid.com/sandbox.

Leave Name ID format as UNSPECIFIED and Name ID as Basic Information > Primary email, then click Continue.

Service provider details with the ACS URL and entity ID

Step 3: Attribute mapping

Under the Attributes section, you have to configure the following attributes:

App attributesGoogle directory attributes
emailPrimary email
firstNameFirst name
lastNameLast name

After you have configured the attributes, click Finish to save the configuration.

Attribute mapping with email, firstName and lastName

From the next screen, click User access to configure the application to allow users to log in.

App overview with the User access card

Check the ON for everyone option and click Save.

Service status set to ON for everyone

Step 4: Use the IdP metadata

Use the metadata XML file you downloaded in Configure application.

Finish in OrbitID

Finish in OrbitID: paste the IdP metadata URL or XML into the connection form (or the Admin Portal link). In the dashboard, open the environment, go to Connections, click New connection, choose SAML and paste the metadata URL or the XML you downloaded. If your customer's admin is following an Admin Portal link, they paste it into the final step of the portal instead.

You can also create the connection with the API: POST /api/v1/sso as described in the quickstart.