Skip to content

Commit b54284f

Browse files
authored
Merge pull request #3896 from replicatedhq/add-ep-auto-invite-ability
Add docs for EP auto-invite on customer creation
2 parents 6ea40c3 + d16fec5 commit b54284f

3 files changed

Lines changed: 30 additions & 6 deletions

File tree

docs/vendor/enterprise-portal-invite.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,21 @@ To enable the Enterprise Portal on a per-customer basis:
3434
When the global **Enable Enterprise Portal for all customers** setting is on, the per-customer toggle is disabled. To manage Enterprise Portal access on a per-customer basis, disable the global setting. See [Enable the Enterprise Portal Globally](#enable-global).
3535
:::
3636

37+
### Automatically invite customers on creation {#auto-invite}
38+
39+
You can enable automatic invitations so that each new customer automatically receives an Enterprise Portal invitation on creation.
40+
41+
You can also override this global automatic invitation setting for individual customers. For more information, see [Create a customer](releases-creating-customer#create-a-customer).
42+
43+
#### Requirements
44+
* Enable the **Enterprise Portal > Customer Access > Enable Enterprise Portal for all customers** setting. Disabling this setting automatically turns off automatic invitations. See [Enable the Enterprise Portal globally](#enable-global) on this page.
45+
46+
#### Enable automatic Enterprise Portal invitations
47+
48+
To enable automatic invitations:
49+
50+
* In the Vendor Portal, go to **Enterprise Portal > Customer Access**. In the **Portal Access** section, enable the **Automatically invite customer email to Enterprise Portal on creation** toggle.
51+
3752
## Configure allowed domains for user invitations
3853

3954
You can restrict user invitations for a customer's Enterprise Portal to specific email domains. When you add allowed domains for a customer, only users with allowed email domains can be invited to the Enterprise Portal.
@@ -62,6 +77,10 @@ To view Enterprise Portal email history and delivery status, do one of the follo
6277

6378
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 Team Settings](/vendor/enterprise-portal-use#manage-team-settings) in _Log In To and Use the Enterprise Portal_.
6479

80+
:::note
81+
You can also configure automatic invitations so that new customers receive an Enterprise Portal invite when you create them. See [Automatically Invite Customers on Creation](#auto-invite).
82+
:::
83+
6584
To invite users to the Enterprise Portal:
6685

6786
1. Enable access to the Enterprise Portal for the customer. See [Manage Access to the Enterprise Portal](#manage-ep-access) above.

docs/vendor/releases-creating-customer.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@ To create a customer:
2626

2727
1. For **Customer name**, enter a name for the customer.
2828

29-
1. For **Customer email**, enter the email address for the customer.
29+
1. For **Customer email**, enter the email address for the customer. A customer email address is required for Helm installations. This email address is never used to send emails to customers.
3030

31-
:::note
32-
A customer email address is required for Helm installations. This email address is never used to send emails to customers.
33-
:::
31+
1. (Optional) Disable the **Send Enterprise Portal invite to customer email** checkbox if you don't want the Enterprise Portal to automatically send this customer an invitation. If you disable the checkbox, you can manually invite the customer to the Enterprise Portal later.
32+
33+
:::note
34+
The **Send Enterprise Portal invite to customer email** checkbox appears only when the Enterprise Portal is enabled globally for all customers. For more information, see [Automatically invite customers on creation](enterprise-portal-invite#auto-invite) in _Manage Enterprise Portal customer access_.
35+
:::
3436

3537
1. For **Assigned channel**, assign the customer to one of your channels. You can select any channel that has at least one release. The channel a customer is assigned to determines the application releases that they can install.
3638

docs/vendor/team-management-rbac-configuring.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ This policy is automatically created for teams with the Enterprise plan only.
101101

102102
### Sales
103103

104-
The Sales policy grants read-write access to customers and license details, read-only access to resources necessary to manage licenses (applications, channels, and license fields), the ability to manage the user's own notification subscriptions, and read-only access to the activity stream and Enterprise Portal data.
104+
The Sales policy grants read-write access to customers and license details. It also grants read-only access to applications, channels, license fields, the activity stream, and Enterprise Portal data. Additionally, it grants the ability to manage notification subscriptions and invite Enterprise Portal customer users.
105105

106106
:::note
107107
This policy is automatically created for teams with the Enterprise plan only.
@@ -125,7 +125,10 @@ This policy is automatically created for teams with the Enterprise plan only.
125125
"team/notifications/types/list",
126126
"team/notifications/events/read",
127127
"team/activity-stream/read",
128-
"kots/app/*/enterprise-portal/**/read"
128+
"kots/app/*/enterprise-portal/**/read",
129+
"kots/app/*/enterprise-portal/customer-users/read",
130+
"kots/app/*/enterprise-portal/customer-user/create",
131+
"kots/app/*/enterprise-portal/customer-user/login"
129132
],
130133
"denied": [
131134
"**/*"

0 commit comments

Comments
 (0)