You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/build/set-up-options/self-serve-portal-for-orgs.mdx
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,9 +37,11 @@ A self-serve portal means your customers can make basic account changes without
37
37
## Configure the organization self-serve portal
38
38
39
39
1. Go to **Settings > Environment > Self-serve portal**.
40
+

40
41
2. Enter the **Return URL** that you want users to land on when they exit the portal, e.g. your app dashboard.
41
42
3. Add an **Organization alias** to represent how your customers are referred to in your business, e.g. Account, Partner, Workspace, etc. This will be visible in the interface in the portal.
42
43
4. In the **Organization profile** section, select the functions you want organization admins to be able to manage.
44
+

43
45
5. Select **Save**.
44
46
45
47
## Portal access control with system permissions
@@ -48,7 +50,9 @@ Each core function within the self-serve portal is governed by a corresponding s
48
50
49
51
These permissions can be included in your custom roles and assigned to organization members.
50
52
51
-
We recommend creating custom roles with varying levels of portal access, which you can then assign as needed. For instance, you might create a role that allows members to view billing details but not update them.
53
+
We recommend creating custom roles with varying levels of portal access, which you can then assign as needed. For instance, you might create a role that allows members to view billing details but not update them. You can select these permissions within your existing roles, or when you create them.
54
+
55
+

52
56
53
57
When [configuring org roles](/billing/get-started/add-billing-role/), you can specify whether it should be:
54
58
@@ -57,7 +61,9 @@ When [configuring org roles](/billing/get-started/add-billing-role/), you can sp
57
61
58
62
## Generate the self-serve portal link
59
63
60
-
Access to the portal is granted via a one-time link. There are two main ways to generate this link:
64
+
Access to the portal is granted via a one-time link. You then use the link on an 'account' or 'profile' button in your app to open the Kinde portal screens.
65
+
66
+
There are two main ways to generate this link:
61
67
62
68
-**Using the user's access token** (recommended)
63
69
-**Using the Kinde Management API**
@@ -113,3 +119,9 @@ Make a request to the `POST /api/v1/portal/generate_url` endpoint using an M2M t
113
119
```
114
120
115
121
This will return a one-time portal link for the specified user.
122
+
123
+
## How the self-serve portal looks
124
+
125
+
When the user clicks the link you've added to your app, the portal opens. The default design is shown below, and we are working on allowing you to style this yourself. The options a member sees depends on their role and what you have chosen to display.
126
+
127
+

Copy file name to clipboardExpand all lines: src/content/docs/build/set-up-options/self-serve-portal-for-users.mdx
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,8 +38,10 @@ A self-serve portal means your customers can make basic account changes without
38
38
## Configure the user self-serve portal
39
39
40
40
1. Go to **Settings > Environment > Self-serve portal**.
41
+

41
42
2. Enter the **Return URL** that you want users to land on when they exit the portal, e.g. your app dashboard. This can also be used as a fallback URL if you decide to use the SDK method of dynamically generting the URL (see below).
42
43
3. In the **User profile** section, select the functions you want the user to be able to manage. If you select **Billing**, they can manage their plan as well as payment methods.
44
+

43
45
4. Select **Save**.
44
46
45
47
## Generate the self-serve portal link
@@ -98,3 +100,13 @@ Make a request to the `POST /api/v1/portal/generate_url` endpoint using an M2M t
98
100
```
99
101
100
102
This will return a one-time portal link for the specified user.
103
+
104
+
## How the self-serve portal looks
105
+
106
+
When the user clicks the link you've added to your app, the portal opens. The default design is shown below, and we are working on allowing you to style this yourself. The options a member sees depends on their role and what you have chosen to display.
107
+
108
+

109
+
110
+
You can also watch this short video showing how the portal works when a customer signs up for a plan using Kinde billing.
111
+
112
+
<YoutubeVideovideoId="xxVwZW8OxIA"videoTitle="The customer billing experience with Kinde"/>
0 commit comments