Skip to content

Commit f4890d7

Browse files
hassankhanhassankhan
authored
docs(product): add guide for single sign-on with Google Workspace (#7060)
1 parent ad1b146 commit f4890d7

File tree

3 files changed

+114
-1
lines changed

3 files changed

+114
-1
lines changed

‎docs/docs-new/pages/product/workspace/sso.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ Single sign-on works with various identity providers. Check the following guides
3232
to get tool-specific instructions:
3333

3434
<Grid imageSize={[56, 56]}>
35+
<GridItem
36+
url="sso/google-workspace"
37+
imageUrl="https://static.cube.dev/icons/google-cloud.svg"
38+
title="Google Workspace"
39+
/>
3540
<GridItem
3641
url="sso/okta"
3742
imageUrl="https://static.cube.dev/icons/okta.svg"

‎docs/docs-new/pages/product/workspace/sso/_meta.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
module.exports = {
2+
"google-workspace": "Google Workspace",
23
"okta": "Okta"
3-
}
4+
}

‎docs/docs-new/pages/product/workspace/sso/google-workspace.mdx‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Google Workspace
2+
3+
Cube Cloud supports authenticating users through Google Workspace, which is
4+
useful when you want your users to access Cube Cloud using single sign on. This
5+
guide will walk you through the steps of configuring SAML authentication in Cube
6+
Cloud with Google Workspace. You **must** be a super administrator in your
7+
Google Workspace to access the Admin Console and create a SAML integration.
8+
9+
<SuccessBox>
10+
11+
Single sign-on with Google Workspace is available in Cube Cloud on
12+
[Enterprise](https://cube.dev/pricing) tier.
13+
[Contact us](https://cube.dev/contact) for details.
14+
15+
</SuccessBox>
16+
17+
## Enable SAML in Cube Cloud
18+
19+
First, we'll enable SAML 2.0 authentication in Cube Cloud. To do this, log in to
20+
Cube Cloud and
21+
22+
1. Click your username from the top-right corner, then click <Btn>Team &
23+
Security</Btn>.
24+
25+
2. On the <Btn>Authentication & SSO</Btn> tab, ensure <Btn>SAML 2.0</Btn> is
26+
enabled:
27+
28+
<Screenshot
29+
alt="Cube Cloud Team Authentication and SSO tab"
30+
src="https://ucarecdn.com/f5ff1413-f37c-4476-afcc-0ff29e87e80a/"
31+
/>
32+
33+
Take note of the <Btn>Single Sign On URL</Btn> and <Btn>Service Provider Entity
34+
ID</Btn> values here, as we will need them in the next step when we configure
35+
the SAML integration in Google Workspace.
36+
37+
## Create a SAML Integration in Google Workspace
38+
39+
Next, we'll create a [SAML app integration for Cube Cloud in Google
40+
Workspace][google-docs-create-saml-app].
41+
42+
1. Log in to [admin.google.com](https://admin.google.com) as an administrator,
43+
then navigate to
44+
45+
<Btn>Apps → Web and Mobile Apps</Btn> from the left sidebar.
46+
47+
2. Click <Btn>Add App</Btn>, then click <Btn>Add custom SAML app</Btn>:
48+
49+
<Screenshot src="https://ucarecdn.com/5898f666-a2b4-44b5-ae9e-03832d9966bc/" />
50+
51+
3. Enter a name for your application and click <Btn>Next</Btn>. You can
52+
optionally add a description and upload a logo for the application, but this
53+
is not required. Click <Btn>Continue</Btn> to go to the next screen.
54+
55+
<Screenshot src="https://ucarecdn.com/b8fe1ad6-6f31-42ed-908c-3e1b72a3d2f1/" />
56+
57+
4. Take note of the <Btn>SSO URL</Btn>, <Btn>Entity ID</Btn> and
58+
<Btn>Certificate</Btn> values here, as we will need them when we finalize the
59+
SAML integration in Cube Cloud. Click <Btn>Continue</Btn> to go to the next screen.
60+
61+
<Screenshot src="https://ucarecdn.com/3f046773-d2d1-424f-a8f8-b023e4896eb1/" />
62+
63+
5. Enter the following values for the <Btn>Service provider details</Btn>
64+
section and click <Btn>Continue</Btn>.
65+
66+
| Name | Description |
67+
| --------- | ------------------------------------------------------------------- |
68+
| ACS URL | Use the <Btn>Single Sign On URL</Btn> value from Cube Cloud |
69+
| Entity ID | Use the <Btn>Service Provider Entity ID</Btn> value from Cube Cloud |
70+
71+
<Screenshot src="https://ucarecdn.com/f7e49547-e0ad-4fa3-902b-536e5926a0bc/" />
72+
73+
5. On the final screen, click <Btn>Finish</Btn>.
74+
75+
6. From the app details page, click <Btn>User access</Btn> and ensure the app is
76+
<Btn>ON for everyone</Btn>:
77+
78+
<Screenshot src="https://ucarecdn.com/8e1696fa-828c-4be5-a1d8-81c7b054dadb/" />
79+
80+
## Enable SAML in Cube Cloud
81+
82+
In this step, we'll finalise the configuration by entering the values from our
83+
SAML integration in Google into Cube Cloud.
84+
85+
1. From the same <Btn>Authentication & SSO > SAML 2.0</Btn> tab, click the
86+
<Btn>Advanced Settings</Btn> tab:
87+
88+
<Screenshot src="https://ucarecdn.com/5359c52e-69c1-45fa-baf2-d3bb07d72634/" />
89+
90+
2. Enter the following values in the <Btn>SAML Settings</Btn> section:
91+
92+
| Name | Description |
93+
| --------------------------- | ------------------------------------------------------------------ |
94+
| Audience (SP Entity ID) | Delete the prefilled value and leave empty |
95+
| IdP Issuer (IdP Entity ID) | Use the <Btn>Issuer</Btn> value from Google Workspace |
96+
| Identity Provider Login URL | Use the <Btn>Sign on URL</Btn> value from Google Workspace |
97+
| Certificate | Use the <Btn>Signing Certificate</Btn> value from Google Workspace |
98+
99+
3. Scroll down and click <Btn>Save SAML 2.0 Settings</Btn> to save the changes.
100+
101+
## Test SAML authentication
102+
103+
To start using SAML authentication, use the
104+
[single sign-on URL provided by Cube Cloud](#enable-saml-in-cube-cloud)
105+
(typically `<YOUR_CUBE_CLOUD_URL>/sso/saml`) to log in to Cube Cloud.
106+
107+
[google-docs-create-saml-app]: https://support.google.com/a/answer/6087519?hl=en

0 commit comments

Comments
 (0)