Skip to content
  • Build on Kinde
  • Self-service portal

Enable self-service portal for users

You can configure a self-serve portal to enable users to be able to self-manage functions provided by Kinde. For example, you can allow users to update their profile, as well as their billing subscription, payment details, and billing information (if you have billing set up). If you have a B2C business, you might want to set this up.

A self-serve portal means your customers can make basic account changes without contacting you for support. This can save time and money.

Configure the user self-serve portal

Link to this section
  1. Go to Settings > Environment > Self-serve portal.

    Self-serve portal settings in Kinde

  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 generating the URL (see below).

User self-management

Link to this section

User self-management options in Kinde

Allows users to update their profile information, including first name, and last name.

If you do not want users to change these fields, disable User profile.

When users sign in with a social provider (for example, Google), the social profile can take priority and overwrite name values the next time they sign in.

Also, name changes might not appear in your app immediately if an old access token is still being used. Users need to refresh the access token or sign out and sign in again.

Allows users to manage their billing subscription, change or cancel their plan, update payment details, and buy one-time purchases configured on their plan (if you have billing set up). When a cancel is scheduled for the end of a billing period, they can Keep my plan before that date if they initiated the cancel. See One-time purchases and Cancel a subscription.

On Payment details, users can also view Billing information (email, phone, description, address, and tax IDs) and select Edit to change it. Tax IDs are optional and can appear on invoices. Viewing billing information requires family:read:billing. Updating billing information requires family:write:billing, the same permission as updating payment methods. Grant each permission only to roles that need it.

User-plan checkout still collects payment method details only. Collecting a business name and Bill-to address on the payment step is an organization setting. Users can add or correct billing information in the portal after they subscribe.

Allows users to create and manage their API keys.

Allows organization members to open your connected workforce applications directly from the portal. Each application you have made available appears as a tile, and selecting one signs the person in to that tool using Kinde as the identity provider.

This module is off by default. Turn it on in Settings > Environment > Self-serve portal.

A tile appears only when all of the following are true for that application:

  • The application is Enabled.
  • Show on self-serve portal is turned on for it.
  • The person’s organization is allowed, if you have restricted the application under Limit to organizations.
  • The person holds an allowed role, if role-based access control is turned on for it.

To set these up, see Add and configure a SAML application.

Link to this section

Access to the portal is granted via a one-time link.

You can generate the portal link on the fly when a user clicks an “Account” button in your app.

Generate using a Kinde SDK

Link to this section

If you’re using the Kinde React SDK, you can use the <PortalLink /> component, which both generates the link and redirects the user:

import {PortalLink} from "@kinde-oss/kinde-auth-react/components";
<PortalLink>Account</PortalLink>;

Generate without an SDK

Link to this section

If you’re not using a Kinde SDK, you can manually call the Account API:

const response = await fetch("/account_api/v1/portal_link", {
headers: {
Authorization: `Bearer ${userAccessToken}`
}
});
const data = await response.json();
window.location = data.url;

Optional parameters:

  • subnav – specify the portal section to open (e.g., organization_details, profile).
  • return_url – where to redirect the user after exiting the portal.

See Get self-serve portal link for all the supported values.

The link opens the portal for the organization in the user’s access token (org_code claim). The plan and payment pages manage the signed-in user’s own subscription (a user plan), not an organization’s subscription. Kinde still ties each user plan to an organization, so a user who belongs to multiple organizations can hold a different user plan in each — the org_code in the token selects which subscription the portal shows. If the token has no org_code, or names an organization the user is no longer a member of, those billing pages are not available and the link opens on profile instead.

How the self-serve portal looks

Link to this section

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.

Self-serve portal as a user sees it