Skip to content

Commit ecb73a4

Browse files
authored
Merge pull request #1081 from segmentio/update-sso-instructions
Update SSO instructions
2 parents c9355f9 + 99fe818 commit ecb73a4

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

src/segment-app/iam/sso.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
title: "Single Sign On team management"
33
---
44

5-
Segment supports Single Sign On for Business Tier accounts. You can use any SAML-based Identity Provider (IDP), for example Okta, Bitium, OneLogin, or Centrify, or use GSuite to serve as your identity provider, delegating access to the application based on rules you create in your central identity management solution.
5+
Segment supports Single Sign On for Business Tier accounts. You can use any SAML-based Identity Provider (IdP), for example Okta, Bitium, OneLogin, or Centrify, or use GSuite to serve as your identity provider, delegating access to the application based on rules you create in your central identity management solution.
66

7-
With SSO, you have centralized control over your users' ability to authenticate or not in your IDP, and can also enforce rules like two-factor authentication or password rotation at the IDP level.
7+
With SSO, you have centralized control over your users' ability to authenticate or not in your IdP, and can also enforce rules like two-factor authentication or password rotation at the IdP level.
88

9-
You can configure as many IDP connections to your workspace as needed to support IDP-initiated authentication. This allows seamless migration from one system to a new one, for example if your organization switches IDP vendors or switches from GSuite to a dedicated SAML IDP like Okta or OneLogin.
9+
You can configure as many IdP connections to your workspace as needed to support IdP-initiated authentication. This allows seamless migration from one system to a new one, for example if your organization switches IdP vendors or switches from GSuite to a dedicated SAML IdP like Okta or OneLogin.
1010

1111
To enable SSO-based login from the Segment login page (app.segment.com/login), you must first verify that you own the domain, and connect it to your organization's Segment account. Once you have done that, SSO users from your domain can use the Segment login page to access your default Segment workspace.
1212

13-
The Segment login page can only be connected to one workspace. To use your IDP with multiple workspaces, you will have to initiate login to the other workspaces from the IDP instead of through the login portal.
13+
The Segment login page can only be connected to one workspace. To use your IdP with multiple workspaces, you will have to initiate login to the other workspaces from the IdP instead of through the login portal.
1414

1515
## Set up — SAML
1616

@@ -22,9 +22,11 @@ To get started, go to your workspace settings and choose the "Connections" tab u
2222

2323
![](images/asset_XCyMZpwo.png)
2424

25-
## Prepare your IDP for the connection.
25+
## Prepare your IdP for the connection.
2626

27-
To get started, you'll need to create an application in your IDP. We're in the process of rolling out officially supported apps with the most popular IDPs, but in the meantime you can create a custom SAML-based application.
27+
Segment officially supports apps for Okta, Azure AD, and OneLogin. Next, find Segment in your IdP's app catalog, and follow the set up instructions they provide.
28+
29+
If you're using a different IdP, you must create a custom SAML-based application.
2830

2931
Your provider will ask you for a few things from Segment, which we provide in the set up flow:
3032

@@ -34,37 +36,37 @@ Your provider will ask you for a few things from Segment, which we provide in th
3436

3537
- For GSuite configurations, make sure the `Start URL` field in Service Provider Details is left blank.
3638

37-
- Different IDPs have different names for the Audience URL. Some call it "Audience URI", some call it "Entity ID", some call it "Service Provider Entity ID." It's likely there are only two required fields without correct defaults, and they correspond to the `SSO URL` and `Audience URL` values above.
39+
- Different IdPs have different names for the Audience URL. Some call it "Audience URI", some call it "Entity ID", some call it "Service Provider Entity ID." It's likely there are only two required fields without correct defaults, and they correspond to the `SSO URL` and `Audience URL` values above.
3840

39-
- In all IDPs we've worked with, the default `NameID` option is the correct one. Make sure it's using the `emailAddress` schema.
41+
- In all IdPs we've worked with, the default `NameID` option is the correct one. Make sure it's using the `emailAddress` schema.
4042

41-
- In all IDPs we've worked with, the default connection encryption options are the correct ones. (Signed Response & Assertion Signature with SHA256, Unencrypted Assertions).
43+
- In all IdPs we've worked with, the default connection encryption options are the correct ones. (Signed Response & Assertion Signature with SHA256, Unencrypted Assertions).
4244

43-
- Different IDPs store records of your employees differently. The only attribute mapping we require is to make sure you're sending `email` . In Okta this is at `user.email`. In Duo this is `mail`.
45+
- Different IdPs store records of your employees differently. The only attribute mapping we require is to make sure you're sending `email` . In Okta this is at `user.email`. In Duo this is `mail`.
4446

45-
- Make sure you've enabled "send all attributes" (not just NameID) if applicable for your IDP.
47+
- Make sure you've enabled "send all attributes" (not just NameID) if applicable for your IdP.
4648

4749
- No `RelayState` is required. This is also sometimes called `Target`.
4850

49-
Once you create the application in your IDP, you can come back to Segment and click "Next".
51+
Once you create the application in your IdP, you can come back to Segment and click "Next".
5052

51-
## Configure Segment to Talk to Your IDP.
53+
## Configure Segment to Talk to Your IdP.
5254

53-
Your IDP provides a URL and x.509 certificate. Copy them into their respective fields in Segment.
55+
Your IdP provides a URL and x.509 certificate. Copy them into their respective fields in Segment.
5456

5557
![](images/asset_s19XDgWX.png)
5658

5759
Then, click "Configure Connection."
5860

5961
You're all set!
6062

61-
## Test your connection with IDP-initiated SSO.
63+
## Test your connection with IdP-initiated SSO.
6264

6365
Back at the connections page, make sure your connection is enabled with the switch on the right.
6466

6567
![](images/asset_SNxN4JhO.png)
6668

67-
You can now test using IDP-initiated SSO (by clicking login to Segment from within your IDP) is working correctly. If not, double check the IDP configuration gotchas section above.
69+
You can now test using IdP-initiated SSO (by clicking login to Segment from within your IdP) is working correctly. If not, double check the IdP configuration gotchas section above.
6870

6971
## Set up — GSuite
7072

@@ -91,17 +93,17 @@ Enter your domain and click "Add Domain." When you click verify, you're given tw
9193

9294
##### Do you support automatic user provisioning?
9395

94-
Segment supports "just in time" user permissioning; new users who authenticate using your IDP are automatically created in Segment as minimal-access (read-only) members.
96+
Segment supports "just in time" user permissioning; new users who authenticate using your IdP are automatically created in Segment as minimal-access (read-only) members.
9597

96-
If the user already exists in Segment then Segment associates the IDP-identity with the existing Segment user account.
98+
If the user already exists in Segment then Segment associates the IdP-identity with the existing Segment user account.
9799

98100
##### Do you support automatic user de-provisioning?
99101

100-
No. However, since any non-owners must log in with SSO to access your workspace, once you remove their authorization in your IDP they will no longer be able to access your workspace.
102+
No. However, since any non-owners must log in with SSO to access your workspace, once you remove their authorization in your IdP they will no longer be able to access your workspace.
101103

102104
##### Will my users lose access to their other workspaces when I enable SSO?
103105

104-
Segment allows users to own their own workspaces. While your IDP authentication will ensure that any non-owners must have logged in with SSO to access _your workspace_, they can still log into Segment with username and password to access their own workspaces.
106+
Segment allows users to own their own workspaces. While your IdP authentication will ensure that any non-owners must have logged in with SSO to access _your workspace_, they can still log into Segment with username and password to access their own workspaces.
105107

106108
##### Can I still invite people outside the organization?
107109

0 commit comments

Comments
 (0)