Skip to content

Commit d86ce17

Browse files
Update googleapps-authentication.mdx (#2589)
* Update googleapps-authentication.mdx Minor typos and grammatical errors * Update src/pages/docs/security/authentication/googleapps-authentication.mdx --------- Co-authored-by: Steve Fenton <[email protected]>
1 parent ca2c52a commit d86ce17

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

src/pages/docs/security/authentication/googleapps-authentication.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2023-01-01
4+
modDate: 2024-12-10
55
title: Google Workspace authentication
6-
description: Octopus Deploy can use GOogle Workspace authentication to identify users.
6+
description: Octopus Deploy can use Google Workspace authentication to identify users.
77
navOrder: 15
88
---
99
import AdminUser from 'src/shared-content/installation/admin-user.include.md';
1010

11-
To use Google Workspace authentication with Octopus Server, Google Workspace must be configured to trust Octopus - by setting it up as an app. This section covers the details on how to configure the app.
11+
To use Google Workspace authentication with Octopus Server, Google Workspace must be configured to trust Octopus by setting it up as an app. This section covers the details of configuring the app.
1212

1313
## Configure Google Workspace
1414

@@ -23,22 +23,22 @@ Once you have an account, log in to [https://console.developers.google.com](http
2323
3. Click the **Configure consent screen** button.
2424
4. Select the User Type **Internal** and click **Create**.
2525
5. Fill out the **App information**, including a descriptive **App name** such as Octopus Server or Octopus Cloud, and select an appropriate **User support email**.
26-
6. Fill out the the **App logo** details, upload a logo to make it easy to identify the application. You can download the Octopus logo [here](https://octopus.com/images/company/Logo-Blue_140px_rgb.png "width=500").
26+
6. Fill out the **App logo** details and upload a logo to make it easy to identify the application. You can download the Octopus logo [here](https://octopus.com/images/company/Logo-Blue_140px_rgb.png).
2727
7. Fill out the **App domain** information, providing `https://octopus.com` as the **Application home page**, `https://octopus.com/privacy` as the **Application privacy policy link** and `https://octopus.com/legal/customer-agreement` as the **Application Terms of Service link**. Add the Top Level Domain of your Octopus instance to the **Authorized domains** list. If you are setting Google Workspaces up for **Octopus Cloud** this will be `octopus.app` and `octopus.com`.
2828
8. Fill out the **Developer contact information**.
2929
9. Click **Save and continue**.
3030
10. On the **Scopes** screen, click **Save and continue**.
3131
11. Click **Back to dashboard**
3232
12. Select **Credentials** tab and click **Create credentials**, selecting **Create Oauth client ID**.
33-
13. Under **Application type**, select `Web application`, In the **Name** field enter `Octopus`, click **Add URI** and enter `https://octopus.example.com/api/users/authenticatedToken/GoogleApps` (replacing `https://octopus.example.com` with the url of your Octopus Server) to the **Authorized redirect URIs** and click **Create**.
33+
13. Under **Application type**, select `Web application`, In the **Name** field enter `Octopus`, click **Add URI**, and enter `https://octopus.example.com/api/users/authenticatedToken/GoogleApps` (replacing `https://octopus.example.com` with the URL of your Octopus Server) to the **Authorized redirect URIs** and click **Create**.
3434
14. Enter a **Name** for identification, e.g. Octopus. This is the name that will appear when the user is asked to allow access to their details.
3535
15. Take note of the **Client ID** and **Client secret** from the `OAuth client created` modal.
3636

3737
:::div{.hint}
3838
**Tips:**
39-
- **Reply URLs are case-sensitive** - Be aware that the path in this URL after the domain name was **case sensitive** during our testing.
40-
- **Not using SSL?** - We highly recommend using SSL, but we know its not always possible. You can use `http` if you do not have SSL enabled on your Octopus Server. Please beware of the security implications in accepting a security token over an insecure channel.
41-
Octopus integrates with [Let's Encrypt](/docs/security/exposing-octopus/lets-encrypt-integration) making it easier to setup SSL on your Octopus Server.
39+
- **Reply URLs are case-sensitive** - Be aware that the path in this URL after the domain name was **case-sensitive** during our testing.
40+
- **Not using SSL?** We highly recommend using SSL, but we know it's not always possible. If you do not have SSL enabled on your Octopus Server, you can use `http`. Please beware of the security implications of accepting a security token over an insecure channel.
41+
Octopus integrates with [Let's Encrypt](/docs/security/exposing-octopus/lets-encrypt-integration), making it easier to set up SSL on your Octopus Server.
4242
:::
4343

4444
## Configure Octopus Server
@@ -81,9 +81,9 @@ If you already have Octopus user accounts and you want to enable external authen
8181

8282
We do our best to log warnings to your Octopus Server log whenever possible. If you are having difficulty configuring Octopus to authenticate with Google Workspace, be sure to check your [server logs](/docs/support/log-files) for warnings.
8383

84-
### Double and triple check your configuration
84+
### Double and triple-check your configuration
8585

86-
Unfortunately security-related configuration is sensitive to everything. Make sure:
86+
Unfortunately, security-related configuration is sensitive to everything. Make sure:
8787

8888
- You don't have any typos or copy-paste errors.
8989
- Remember things are case-sensitive.
@@ -95,9 +95,9 @@ You can see the OpenID Connect metadata by going to [https://accounts.google.com
9595

9696
### Inspect the contents of the security token
9797

98-
Perhaps the contents of the security token sent back by Google Workspace aren't exactly the way Octopus expected, especially certain claims which may be missing or named differently. This will usually result in the Google Workspace user incorrectly mapping to a different Octopus User than expected. The best way to diagnose this is to inspect the JSON Web Token (JWT) which is sent from Google Workspace to Octopus via your browser. To inspect the contents of your security token:
98+
Perhaps the contents of the security token sent back by Google Workspace aren't exactly the way Octopus expected, especially certain claims that may be missing or named differently. This will usually result in the Google Workspace user incorrectly mapping to a different Octopus User than expected. The best way to diagnose this is to inspect the JSON Web Token (JWT) which is sent from Google Workspace to Octopus via your browser. To inspect the contents of your security token:
9999

100-
1. Open the Developer Tools of your browser and enable Network logging making sure the network logging is preserved across requests.
100+
1. Open your browser's Developer Tools and enable Network logging, making sure the network logging is preserved across requests.
101101
2. In Chrome Dev Tools this is called "Preserve Log":
102102

103103
:::figure
@@ -117,5 +117,5 @@ Perhaps the contents of the security token sent back by Google Workspace aren't
117117
:::
118118

119119
5. Don't worry if jwt.io complains about the token signature, it doesn't support RS256 which is used by Google Workspace.
120-
6. Octopus uses most of the data to validate the token, but primarily uses the `sub`, `email` and `name` claims. If these claims are not present you will likely see unexpected behavior.
120+
6. Octopus uses most of the data to validate the token, but it primarily uses the `sub`, `email`, and `name` claims. If these claims are not present, you will likely see unexpected behavior.
121121
7. If you are not able to figure out what is going wrong, please send a copy of the decoded payload to our [support team](https://octopus.com/support) and let them know what behavior you are experiencing.

0 commit comments

Comments
 (0)