Skip to content

Commit 26a0b65

Browse files
Initial stab at adding SAML for EP documentation
1 parent a0142de commit 26a0b65

File tree

6 files changed

+61
-3
lines changed

6 files changed

+61
-3
lines changed

docs/vendor/enterprise-portal-invite.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,18 @@ To configure allowed domains for a customer's Enterprise Portal invitations:
4242

4343
1. In the text box, enter a domain to add to the allowlist. Click **Add domain**. Add more domains as needed.
4444

45+
## Enable SAML Authentication (Alpha)
46+
47+
:::note
48+
SAML Authentication to the Enterprise Portal is Alpha and subject to change. To access this feature, a feature flag must be enabled for your team. For more information, reach out to your Replicated account representative.
49+
:::
50+
51+
You can allow customers to configure and use SAML SSO for Enterprise Portal access. When enabled, customers can configure their IdP details in the Enterprise Portal. When disabled, even if customers have configured SAML, customers won't be able to use SAML SSO for Enterprise Portal access.
52+
53+
![Enterprise Portal SAML authentication](/images/enterprise-portal-saml-authentication.png)
54+
55+
[View a larger version of this image](/images/enterprise-portal-saml-authentication.png)
56+
4557
## Invite Users
4658

4759
This section describes how to invite users to the Enterprise Portal from the Vendor Portal. Your customers can also invite users to the Enterprise Portal from the Enterprise Portal **Team settings** page. For more information about using the **Team settings** page, see [Manage Users](enterprise-portal-use#manage-users) in _Access and Use the Enterprise Portal_.

docs/vendor/enterprise-portal-use.mdx

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,21 @@ To sign up for a self-service account and log in to the Enteprise Portal:
4040

4141
[View a larger version of this image](/images/self-serve-signup-screen.png)
4242

43-
1. Go to your email account and open the automated account creation email. Follow the link provided in the email to log in.
43+
1. Go to your email account and open the automated account creation email. Follow the link provided in the email to log in.
44+
45+
### SAML Authentication (Alpha)
46+
47+
:::note
48+
SAML Authentication to the Enterprise Portal is Alpha and subject to change. To access this feature, a feature flag must be enabled for your team. For more information, reach out to your Replicated account representative.
49+
:::
50+
51+
If SAML authentication has been enabled and configured for the Enterprise Portal it will be the preferred login method and attempted automatically.
52+
53+
SAML authentication also supports just-in-time (JIT) provisioning of user accounts as follows:
54+
55+
1. Identity Provider (IdP) initiated SAML login attempts always allow for JIT user provisioning
56+
57+
1. Service Provider (SP) initiated SAML login attempts allow for JIT user provisioning if the user has an active pending invite. See [Invite or Delete Users](#invite-or-delete-users) below.
4458

4559
## View Install and Update Instructions
4660

@@ -197,7 +211,7 @@ To manage licenses in the Enterprise Portal:
197211

198212
## Manage Team Settings
199213

200-
This section includes information about how to manage users and service accounts in the Enterprise Portal.
214+
This section includes information about how to manage users, service accounts, and SAML authentication in the Enterprise Portal.
201215

202216
### Invite or Delete Users
203217

@@ -221,7 +235,7 @@ To manage invite and manage users in the Enterprise Portal:
221235

222236
To manage service accounts in the Enterprise Portal:
223237

224-
1. In the Enterprise Portal, openthe user account dropdown in the top right of the page and select **Team settings**.
238+
1. In the Enterprise Portal, open the user account dropdown in the top right of the page and select **Team settings**.
225239

226240
![enterprise portal team settings](/images/enterprise-portal-user-account.png)
227241

@@ -234,6 +248,38 @@ To manage service accounts in the Enterprise Portal:
234248
* To view a service account token, find the target service account in the table and click **View** under **Token**.
235249
* The revoke a service account's token, find the target service account in the table and open the menu under **Actions**. Select **Revoke**.
236250

251+
### Configure SAML Authentication (Alpha)
252+
253+
:::note
254+
SAML Authentication to the Enterprise Portal is Alpha and subject to change. To access this feature, a feature flag must be enabled for your team. For more information, reach out to your Replicated account representative.
255+
:::
256+
257+
1. In the Enterprise Portal, open the user account dropdown in the top right of the page and select **Team settings**.
258+
259+
![enterprise portal team settings](/images/enterprise-portal-user-account.png)
260+
261+
[View a larger version of this image](/images/enterprise-portal-user-account.png)
262+
263+
1. Click **SAML Authentication**
264+
265+
1. The Service provider information section will display information you can copy and paste to use in your identity provider (IdP).
266+
267+
![enterprise portal SAML service provider information](/images/enterprise-portal-saml-sp-info.png)
268+
269+
[View a larger version of this image](/images/enterprise-portal-saml-sp-info.png)
270+
271+
1. Next, upload the required metadata XML and public certificate from your identity provider.
272+
273+
![enterprise portal SAML configuration](/images/enterprise-portal-saml-config.png)
274+
275+
[View a larger version of this image](/images/enterprise-portal-saml-config.png)
276+
277+
1. Finally, select to enable or disable SAML authentication for the Enterprise Portal. Disabling SAML authentication will leave the stored configuration in place.
278+
279+
![enterprise portal SAML enablement](/images/enterprise-portal-saml-enable.png)
280+
281+
[View a larger version of this image](/images/enterprise-portal-saml-enable.png)
282+
237283
## Manage User Settings
238284

239285
Each user can manage their settings in the Enterprise Portal, including enabling and disabling email notifications for various system events.
47.2 KB
Loading
29.7 KB
Loading
9.35 KB
Loading
26.2 KB
Loading

0 commit comments

Comments
 (0)