How do I configure SAML-based single sign-on for the QuWAN QBelt VPN server with Google Workspace Admin as the Identity Provider?
Applicable Products
- QuWAN Orchestrator
- QVPN Client
- Google Workspace Admin
Details
QuWAN Orchestrator enables the use of Security Assertion Markup Language (SAML)-based single-sign on (SSO) to exchange authentication and authorization data with an Identify Provider (IdP), for example, Google Workspace Admin. With this feature, users can utilize the same SAML IdP credentials to access various services that support SAML authentication. This eliminates the necessity of adding new credentials for each individual application and service.
Procedure
1.Creating a custom SAML-based sign-on for the QuWAN QBelt VPN server using the Google Workspace administrator account
- Go to https://admin.google.com.
- Sign in using your Google Workspace username and password.
The Admin console appears. - Click
.
- Click Apps.
- Click Web and mobile apps.
- Click Add App, and then click Add custom SAML app.
- Specify an app name and description.NoteUse a clear, descriptive name for your custom SAML app, like the service name itself (e.g., "QuWAN QBelt VPN Server").
- Optional: Upload an icon for your app.
- Click Continue.
The Google Identity Provider details page appears. - Copy the SSO URL, Entity ID, and certificate to the clipboard.
- Click Continue.ImportantDo not close the Google Workspace Admin console window after this step. Proceed to configure the SAML SSO settings in QuWAN Orchestrator, then return to the Google Workspace Admin console to complete the custom SAML app creation.
2. Configuring the QuWAN QBelt VPN server settings in QuWAN Orchestrator and Google Workspace Admin console
To enable the Google Workspace Admin SAML SSO, you must create a link between Google Workspace Admin users and their corresponding QuWAN QBelt VPN SAML SSO user groups.
- Configure the SAML SSO settings in QuWAN Orchestrator.
- Go to https://quwan.qnap.com.
- Sign in using your QNAP account username and password.
- Select your organization.
- Go to VPN Server Settings > Privilege Settings.
- Go to SAML SSO.
- In the Basic SAML Configuration field, click
.
The Configure SAML SSO Settings window appears. - Under Identity Provider Information, paste the SSO URL, Entity ID, and certificate information.
- Copy the Identifier (Entity ID) and Reply URL (ACS URL) to the clipboard.
- Click Save.
- Configure the service provider settings in the Google Workspace Admin console.
- Open the Google Workspace Admin console tab on your browser.
The Service provider details page appears. - Paste the copied Identifier (Entity ID) and Reply URL (ACS URL) in their respective fields.
- Click Continue.
The Attribute mapping page appears. - Map user attributes based on the QuWAN SAML SSO requirements.
- Configure the email attribute for identity authentication.
- Click Add mapping.
- Under Google Directory attributes, select Primary email.
- Enter email in the App attributes field.
- Configure the group attribute for permission controls.
- Click Add mapping.
- Under Google Directory attributes, select Department.
- Enter groups in the App attributes field.Tip (Optional)To effectively map QuWAN SAML SSO user rules to corresponding Google Workspace Admin groups, first select the Google groups you want to add to the SAML app under Group membership (optional), and then enter groups as the app attribute.
- Click Save.
Google Workspace Admin console saves the settings.
- Configure the email attribute for identity authentication.
- Open the Google Workspace Admin console tab on your browser.
- Activate the custom app for QuWAN QBelt SAML SSO.
- Go to https://admin.google.com.
- Sign in using your Google Workspace username and password.
The Admin console appears. - Click
.
- Click Apps.
- Click Web and mobile apps.
- Select your customized QuWAN QBelt VPN server app.
- Click User access.
- On the Service status page, select On for everyone.
- Click Save.
- Optional: Activate the service for a set of groups.
- Click Groups.
- Select one or more groups.
- Select On to enable the service.
- Click Save.
3. Adding a SAML SSO user rule in QuWAN Orchestrator
- Open QuWAN Orchestrator.
- Select your organization.
- Go to VPN Server Settings > Privilege Settings.
- Go to SAML SSO.
- Click Configure SAML SSO Now.
- Add a new SAML SSO user group.
- In QuWAN Orchestrator, go to VPN Server Settings > Privilege Settings > SAML SSO.
- Next to SAML SSO User Rules, click Add.
- Enable the user rule.
- Configure the user group settings.
Setting User Action Rule name Specify a name for the SAML SSO user rule. Attribute value The value corresponding to the source attribute configured for the custom SAML app's group attribute in Google Workspace Admin console. Note- If group membership is the configured group attribute in Google Workspace, use the corresponding app attribute value in QuWAN Orchestrator.
- If a different attribute (e.g., Department) is used as the group attribute, employ its corresponding app attribute value in QuWAN Orchestrator. You can find the corresponding value of attribute Department in Google Workspace Admin console's Users page.
- Select Rule for all users to apply the attribute value to all the users.
Segment Select a pre-configured segment. Accessible hubs Select one or more hubs to connect to. - Optional: Enable Allow concurrent multidevice connections.
- Click Save.
- Click Apply.
QuWAN Orchestrator saves the SAML SSO settings.
4. Connecting to QuWAN QBelt VPN server with QVPN Client and Google Workspace Admin SSO
After successfully configuring QuWAN SAML SSO, establish a connection to QuWAN QBelt VPN through the QVPN Client.
- Go to QNAP Utilities.
- Locate QVPN Client (formerly named QVPN Device Client).
- Download the utility to your device.
- Install the utility on the device.
- Open QVPN Client.
- Click Add a QuWAN Profile.
- Specify the organization ID.NoteYou can find the organization ID in QuWAN Orchestrator. Go to VPN Server Settings > Privilege Settings > SAML SSO.
- Click Next.
The Authentication Settings page appears. - Select SAML SSO as the service.
- Click Next.
QVPN Client prompts you to enter the Google Workspace Admin credentials once it opens the default browser. - Click OK.
- Enter your Google Workspace Admin credentials and sign in.
- Close the browser and return to QVPN Client.
- Configure the profile settings.
- Specify a profile name.
- Select a regional hub from the drop-down menu.
You can either let the system automatically select the optimal hub for your needs, or you can manually choose a specific hub and specify the WAN port you want to connect to. - Optional: Select Connect immediately After Save if you want to connect to the QuWAN profile immediately after applying the settings.
- Locate the QuWAN profile in QVPN Client, and then click Connect.
QVPN Client opens the default system browser for user authentication. - Enter your Google Workspace Admin credentials and sign in.
You can close the browser after logging in to Google Workspace Admin and return to QVPN Client.
QVPN Client connects to the QuWAN QBelt VPN Server using Google Workspace Admin SSO.