Skip to content

Add docs for EP auto-invite on customer creation #3896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bennyyang11 merged 5 commits into from
Mar 25, 2026
Merged

Add docs for EP auto-invite on customer creation #3896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9e8bfec
Add docs for Enterprise Portal auto-invite on customer creation
AmberAlston Mar 18, 2026
ba8bc00
Replace :::tip with :::note to match existing docs conventions
AmberAlston Mar 19, 2026
2e732e8
Fix vale style issues: active voice and sentence length
AmberAlston Mar 19, 2026
3c344c3
docs edits
paigecalvert Mar 19, 2026
d16fec5
remove RBAC permission note and update Sales policy with EP invite pe…
bennyyang11 Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/vendor/enterprise-portal-invite.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,21 @@ To enable the Enterprise Portal on a per-customer basis:
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).
:::

### Automatically invite customers on creation {#auto-invite}

You can enable automatic invitations so that each new customer automatically receives an Enterprise Portal invitation on creation.

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).

#### Requirements
* 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.

#### Enable automatic Enterprise Portal invitations

To enable automatic invitations:

* 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.

## Configure allowed domains for user invitations

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.
Expand Down Expand Up @@ -62,6 +77,10 @@ To view Enterprise Portal email history and delivery status, do one of the follo

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_.

:::note
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).
:::

To invite users to the Enterprise Portal:

1. Enable access to the Enterprise Portal for the customer. See [Manage Access to the Enterprise Portal](#manage-ep-access) above.
Expand Down
10 changes: 6 additions & 4 deletions docs/vendor/releases-creating-customer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,13 @@ To create a customer:

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

1. For **Customer email**, enter the email address for the customer.
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.
Comment thread
paigecalvert marked this conversation as resolved.
Copy link
Copy Markdown
Contributor

@paigecalvert paigecalvert Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(also decided that this one about the email being required for Helm installs didn't need to be a note)


:::note
A customer email address is required for Helm installations. This email address is never used to send emails to customers.
:::
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.

:::note
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_.
Comment thread
paigecalvert marked this conversation as resolved.
:::
Copy link
Copy Markdown
Contributor

@paigecalvert paigecalvert Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ @AmberAlston see what you think about this solution to the double note issue. Seemed like the mention of auto invite could be bumped out into it's own optional step, since it's a separate decision

Copy link
Copy Markdown
Member Author

@AmberAlston AmberAlston Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i like this thanks


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.

Expand Down
7 changes: 5 additions & 2 deletions docs/vendor/team-management-rbac-configuring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ This policy is automatically created for teams with the Enterprise plan only.

### Sales

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.
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.

:::note
This policy is automatically created for teams with the Enterprise plan only.
Expand All @@ -125,7 +125,10 @@ This policy is automatically created for teams with the Enterprise plan only.
"team/notifications/types/list",
"team/notifications/events/read",
"team/activity-stream/read",
"kots/app/*/enterprise-portal/**/read"
"kots/app/*/enterprise-portal/**/read",
"kots/app/*/enterprise-portal/customer-users/read",
"kots/app/*/enterprise-portal/customer-user/create",
"kots/app/*/enterprise-portal/customer-user/login"
],
"denied": [
"**/*"
Expand Down
Loading