Skip to content

Commit b974337

Browse files
committed
Merge branch 'main' into docs/ccpa-cpra
2 parents 2cebc06 + 49c191a commit b974337

File tree

9 files changed

+115
-22
lines changed

9 files changed

+115
-22
lines changed

src/content/docs/build/organizations/self-serve-portal-per-org.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This is an advanced feature that is only available on the [Kinde Scale plan](htt
2525

2626
</Aside>
2727

28-
If an organization requires a unique setup for the self-service portal, you can do this using an advanced organiztion function. If you set this up, the authorized members of the organization will be able to perform the selected functions.
28+
If an organization requires a unique setup for the self-service portal, you can do this using an advanced organization function. If you set this up, the authorized members of the organization will be able to perform the selected functions.
2929

3030
1. In Kinde, open the organization you want to customize.
3131
2. In the side menu, select **Self-serve portal**.
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
page_id: deb0b4c6-6436-4a19-be57-b482910af2d5
3+
title: Customer self-serve portal
4+
description: Intro to concept of self-serve portals in Kinde, including what functions they include, how to use them, and when to set them up.
5+
sidebar:
6+
order: 7
7+
relatedArticles:
8+
- a2668524-5842-4c68-ab50-30b7e8c3e842
9+
- f36bce4a-52bb-4785-865b-6b33356f9838
10+
topics:
11+
- self-serve-portal
12+
- organizations
13+
- users
14+
- billing
15+
sdk: []
16+
languages: []
17+
audience: developers
18+
complexity: beginner
19+
keywords:
20+
- organization portal
21+
- self-serve portal
22+
- user portal
23+
- billing portal
24+
- portal permissions
25+
updated: 2024-08-27
26+
featured: false
27+
deprecated: false
28+
ai_summary: Intro to concept of self-serve portals in Kinde, including what functions they include, how to use them, and when to set them up.
29+
---
30+
31+
Customer support is one of the higher overheads for a SaaS business. For paying customers, the expectation is that they get help when needed, for example, to manage their account or get assistance with your app.
32+
33+
Kinde lets you configure a self-serve portal so authorized customers can self-manage functions provided by Kinde. A self-serve portal means your customers can make account changes without contacting you for support, saving everyone time and money.
34+
35+
There's two types of portal: one for end users (B2C), and one for organizations (B2B).
36+
37+
## Watch Dave's portal demo in 90 seconds
38+
39+
<YoutubeVideo videoId="Q3HW6Mgj6wA" videoTitle="Customer portal in 90 seconds"/>
40+
41+
## Self-serve portal for organizations
42+
43+
In the organization portal, you can allow org members to manage:
44+
45+
- Account details
46+
- Payment details (if you have billing set up)
47+
- API Keys (Paid plans)
48+
- Members and roles (Paid plans)
49+
- Multi-factor auth settings (coming soon)
50+
- SSO enterprise connections (almost here - Kinde Scale plan only)
51+
52+
You can enable all functions or limit them to what you offer. [Set up a self-serve portal for an org](/build/set-up-options/self-serve-portal-for-orgs/)
53+
54+
<Aside>
55+
56+
If you are on the Kinde Scale plan, you can configure the [portal per organization](/build/organizations/self-serve-portal-per-org/). E.g. allow some functions for some customers and not others.
57+
58+
</Aside>
59+
60+
## Self-serve portal for users
61+
62+
In the user portal, you can allow users to manage:
63+
64+
- Account details
65+
- Payment details (if you have billing set up)
66+
- API Keys
67+
68+
[Set up a self-serve portal for users](/build/set-up-options/self-serve-portal-for-users/)
69+
70+
## Self-serve portal settings
71+
72+
These are the self-serve portal settings you can enable.
73+
74+
![Self-serve portal settings in Kinde](https://imagedelivery.net/skPPZTHzSlcslvHjesZQcQ/1fd3505c-883b-4b01-8dff-e028e25b6300/public)
75+
76+
## Current limitations
77+
78+
Currently, we don't support any customer design for the portal appearance. However, you can build your own portal and use the [Kinde API](https://docs.kinde.com/kinde-apis/management/) endpoints to provide the functions.

src/content/docs/build/set-up-options/self-serve-portal-for-orgs.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ page_id: a2668524-5842-4c68-ab50-30b7e8c3e842
33
title: Enable self-serve portal for orgs
44
description: Guide for enabling self-serve portals for organizations including business details management, billing access, permission controls, and portal link generation methods.
55
sidebar:
6-
order: 7
6+
order: 8
77
relatedArticles:
88
- f36bce4a-52bb-4785-865b-6b33356f9838
99
topics:
@@ -30,9 +30,18 @@ deprecated: false
3030
ai_summary: Guide for enabling self-serve portals for organizations including business details management, billing access, permission controls, and portal link generation methods.
3131
---
3232

33-
You can configure a self-serve portal to enable authorized organization members to be able to self-manage functions provided by Kinde. For example, you can allow them to update their business details, payment details (if you have billing set up), multi-factor auth settings (coming soon), and manage organization members (coming soon).
33+
You can configure a self-serve portal to enable authorized organization members to be able to self-manage functions provided by Kinde. Authorized org members can update:
3434

35-
A self-serve portal means your customers can make basic account changes without contacting you for support. This can save time and money.
35+
- [Business details](/manage-your-account/business-information/update-your-details/)
36+
- [Payment details](/manage-your-account/profile-and-plan/update-kinde-payment/) (if you have billing set up)
37+
- [API Keys](/manage-your-apis/add-manage-api-keys/self-serve-api-keys/)
38+
- [Members and roles](/get-started/team-and-account/add-team-members/)
39+
- Multi-factor auth settings (coming soon)
40+
- SSO enterprise connections (almost here)
41+
42+
A self-serve portal means your customers can make account changes without contacting you for support. This can save you both time.
43+
44+
If you are on the Kinde Scale plan, you can configure the [portal per organization](/build/organizations/self-serve-portal-per-org/). E.g. allow some functions for some customers and not others.
3645

3746
## Configure the organization self-serve portal
3847

src/content/docs/build/set-up-options/self-serve-portal-for-users.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ page_id: f36bce4a-52bb-4785-865b-6b33356f9838
33
title: Enable self-serve portal for users
44
description: Guide for enabling and configuring self-serve portals for users including profile management, billing access, and multiple methods for generating portal links with SDK and API examples.
55
sidebar:
6-
order: 8
6+
order: 9
77
relatedArticles:
88
- beebe908-27f8-4be6-b74c-05fc8ff5dfb5
99
- a2668524-5842-4c68-ab50-30b7e8c3e842

src/content/docs/developer-tools/your-apis/access-to-your-api.mdx

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ sidebar:
66
relatedArticles:
77
- 6bf993fc-a195-4836-8eaf-133812be8876
88
- cffc17b9-2d10-4f42-8c84-a12b263a6040
9+
- 8f7a2b1c-3d4e-4f6a-8b8c-9d0e1f2a3b4c
910
topics:
1011
- developer-tools
1112
- your-apis
@@ -30,17 +31,19 @@ deprecated: false
3031
ai_summary: Guide to providing programmatic access to APIs for third parties using M2M applications and tokens
3132
---
3233

33-
Although we do not currently have a dedicated feature for it, there is a way to provide your users with programmatic access to your API and applications via Kinde.
34+
There are a number of ways to provide your users with programmatic access to your API and applications via Kinde.
3435

3536
You need to [register your API with Kinde](/developer-tools/your-apis/register-manage-apis/) before you begin.
3637

38+
## API access via an M2M application
39+
3740
Here’s the process:
3841

3942
- Create a machine to machine (M2M) application
4043
- Connect the application to your API
4144
- Provide access to the user via token or app keys
4245

43-
## Create a M2M application
46+
### Create a M2M application
4447

4548
You will want to create a separate M2M application for each user, system, or business who needs to access your API. It is not secure to share access via the same tokens or app keys.
4649

@@ -49,7 +52,7 @@ You will want to create a separate M2M application for each user, system, or bus
4952
3. In the dialog that opens, give the application a name, and select **Machine to Machine** as the **Application type**.
5053
4. Select **Save**. App keys - including **Domain** details, **Client ID** and **Client Secret** - are issued for the application.
5154

52-
## Authorize the API to access the application
55+
### Authorize the API to access the application
5356

5457
1. In the application list, find the M2M app you created and select **View details**.
5558
2. Select **APIs** in the menu. A list of all available APIs shows.
@@ -58,17 +61,13 @@ You will want to create a separate M2M application for each user, system, or bus
5861

5962
If you need to cut off access to your API for a user, select the three dots menu and select **Revoke authorization**.
6063

61-
## Get a token to test API access
62-
63-
Follow this guide to [quickly generate a test token](/developer-tools/your-apis/test-token-from-kinde/) to test access to your API.
64+
## API access via API keys
6465

65-
## Provide access to third parties
66+
Allow users to manage their own API keys to access your API, including initializing the request, rotating, and deleting keys. Follow this [quickstart guide](/manage-your-apis/about-api-keys/api-keys-quick-start/). This is much more secure and preferable than manually copying the app keys from the M2M application and providing them to the third-party.
6667

67-
There are two ways you can provide access to your API: via token or app keys.
68+
## Provide access via a token
6869

69-
### Via token
70-
71-
The third party can request a token using the relevant `audience` in the claim, for example:
70+
A third party can request a token using the relevant `audience` in the claim, for example:
7271

7372
```jsx
7473
POST https://yourbusiness.kinde.com/oauth2/token
@@ -81,6 +80,6 @@ POST https://yourbusiness.kinde.com/oauth2/token
8180
```
8281
Granting access this way means you don't have to share the Client ID and Secret with anyone.
8382

84-
### Via app keys
83+
## Get a test token to test API access
8584

86-
Copy the app keys: **Domain**, **Client ID**, and **Client secret** from the M2M application and provide them to the third-party. This enables them access to the end point, e.g. `http://api.example.com/api`. Providing app keys authorizes access unless the Client secret is rotated or revoked.
85+
Follow this guide to [quickly generate a test token](/developer-tools/your-apis/test-token-from-kinde/) to test access to your API.

src/content/docs/developer-tools/your-apis/api-scopes-m2m-applications.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ sidebar:
55
order: 7
66
relatedArticles:
77
- 815f10b0-7bd2-407a-9ac2-9fb582862a5b
8+
- 8f7a2b1c-3d4e-4f6a-8b8c-9d0e1f2a3b4c
89
- 51899f7f-3436-46e0-9a1b-6ecc3603a0df
910
- 8ace97e7-6c61-4558-babf-ed8435972f75
1011
topics:

src/content/docs/developer-tools/your-apis/custom-api-scopes.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ relatedArticles:
77
- f1ba22b9-b35f-478a-be09-4524d060fe36
88
- 51899f7f-3436-46e0-9a1b-6ecc3603a0df
99
- 6bf993fc-a195-4836-8eaf-133812be8876
10+
- 5d4c3b2a-1e0f-4a9b-8c7d-5e4f3a2b1c0d
1011
topics:
1112
- developer-tools
1213
- your-apis
@@ -106,3 +107,7 @@ curl --request POST \
106107
--data 'audience=<your_api_audience>\
107108
--data 'scope=join:competitions update:competitions'
108109
```
110+
111+
## API Key scopes
112+
113+
If you manage access to your APIs using API keys, you can [set scopes for the API keys](/manage-your-apis/add-manage-api-keys/scopes-for-api-keys/), giving you more granular control over access, depending who has the keys.

src/content/docs/developer-tools/your-apis/protect-your-api.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ sidebar:
77
relatedArticles:
88
- 684fc526-a338-4a67-9af6-742a39b66aff
99
- 4ed081b0-7853-49be-b5fd-22a84a86bdad
10+
- 9e8b7c6d-5f4e-4a2b-8c0d-9e8f7a6b5c4d
1011
topics:
1112
- developer-tools
1213
- your-apis
@@ -79,10 +80,6 @@ Now that the token is being passed from the front end you will need to verify it
7980

8081
We recommend that you use a library to verify your token. If you are using ExpressJS you can use [our library](/developer-tools/sdks/backend/express-sdk/#verify-jwt) or the OpenID Foundation has [a list of libraries for working with JWT tokens](https://openid.net/developers/jwt/).
8182

82-
### **Rolling your own**
83-
84-
We strongly recommend against doing this, but if you have opted to go down this path, this doc provides you all the info about our JWTs.
85-
8683
### **JSON Web Key**
8784

8885
It’s likely the library you decide to use will require the url for your public JSON Web Key (also known as a jwks file).

src/content/docs/developer-tools/your-apis/register-manage-apis.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,10 @@ If you are using Postman, you can include the `audience` claim in a token reques
9191
}
9292
```
9393
94+
## Create API keys
95+
96+
If you want, you can also give access to your API via [API keys](/manage-your-apis/add-manage-api-keys/create-an-api-key/). These can be created by you and then managed by your customer via the [self-serve portal](/build/set-up-options/self-serve-portal-for-orgs/) (optional). You can also [scope API keys to an organization](/manage-your-apis/about-api-keys/organization-api-keys/).
97+
9498
## Authorize or revoke authorization of an app from the API
9599
96100
1. Go to **Settings** > **APIs**.

0 commit comments

Comments
 (0)