Kinde

https://docs.kinde.com
Admin
Kinde is an identity and authentication platform for developers to manage user authentication,...
Tokens:740,519
Snippets:6,768
Trust Score:8.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### React SDK Starter Kit Installation

Source: https://docs.kinde.com/developer-tools/sdks/frontend/react-sdk

Install the Kinde React SDK Starter kit from the Quick start page. Requires a Kinde account and Node.js version 20 or higher.

```bash
npm install @kinde-oss/kinde-auth-react-sdk
```

--------------------------------

### Get access token with useKindeBrowserClient

Source: https://docs.kinde.com/developer-tools/sdks/backend/nextjs-sdk

Starts the example for `accessToken` / `getAccessToken` to get the decoded access token. The code is incomplete in the source.

```javascript
"use client";
import {useKindeBrowserClient} from "@kinde-oss/kinde-auth-nextjs";
```

--------------------------------

### Get timezones response example

Source: https://docs.kinde.com/kinde-apis/management

Example response for a successful GET /api/v1/timezones request. The response includes a code, message, and a list of timezones with key and name fields.

```json
{
  "code": "OK",
  "message": "Success",
  "timezones": [
    {
      "key": "london_greenwich_mean_time",
      "name": "London (Greenwich Mean Time) [+01:00]"
    }
  ]
}
```

--------------------------------

### Start the development server with npm run dev

Source: https://docs.kinde.com/developer-tools/sdks/backend/tsr-sdk

Start the development server to test the authentication flow. After running, navigate to http://localhost:3000 and create an account to be redirected to the Kinde hosted sign-up page.

```bash
npm run dev
```

--------------------------------

### Run the project with bun

Source: https://docs.kinde.com/integrate/third-party-tools/kinde-supabase-todo-app

Use this command to start the development server with bun. After running, go to http://localhost:3000 to preview the app.

```bash
bun run dev
```

--------------------------------

### organization / getOrganization - Get current user's organization (client)

Source: https://docs.kinde.com/developer-tools/sdks/backend/nextjs-sdk

Client-side example using useKindeBrowserClient to get the current user's organization. The example is incomplete in the source.

```javascript
"use client";
import {useKindeBrowserClient} from "@kinde-oss/kinde-auth-nextjs";


const {organization, getOrganization} = useKindeBrowserClient();
const org = getOrganization();
```

--------------------------------

### Create API setup directory and file

Source: https://docs.kinde.com/testing/playwright/test-backend-apis

Commands to create the tests/api directory and the api.setup.ts file.

```bash
mkdir tests/api
touch tests/api/api.setup.ts
```

--------------------------------

### getCurrentOrganization usage example

Source: https://docs.kinde.com/developer-tools/sdks/native/expo

Example of using getCurrentOrganization to get the current organization code.

```typescript
// Get the decoded access token
const orgCode = await getCurrentOrganization();
// org_123456
```

--------------------------------

### Install @kinde-oss/kinde-auth-sveltekit with bun

Source: https://docs.kinde.com/developer-tools/sdks/backend/sveltekit-sdk

Install the Kinde SvelteKit SDK using bun.

```bash
bun add @kinde-oss/kinde-auth-sveltekit
```

--------------------------------

### getFlag usage examples

Source: https://docs.kinde.com/developer-tools/sdks/native/expo

Examples of using getFlag to get feature flag values with different types.

```typescript
// Get the feature flag value
const featureValue = await getFlag("feature_flag_name");


// Define the type of the feature flag
const featureValue = await getFlag<string>("feature_flag_name");
const featureValue = await getFlag<boolean>("feature_flag_name");
const featureValue = await getFlag<number>("feature_flag_name");
const featureValue = await getFlag<object>("feature_flag_name");
```

--------------------------------

### Shell setup for iOS with Bundler and CocoaPods

Source: https://docs.kinde.com/developer-tools/sdks/native/react-native-sdk

Install or update Bundler, create a Gemfile, add CocoaPods, install dependencies, and install pods for the iOS project.

```bash
# Install or update Bundler
gem install bundler


# Create a new Gemfile if it doesn't exist
bundle init


# Add CocoaPods to your Gemfile
bundle add cocoapods


# Install dependencies using Bundler
bundle install


# Install pods for your project
cd ios && bundle exec pod install
```

--------------------------------

### Set up .env file for Kinde

Source: https://docs.kinde.com/developer-tools/sdks/backend/java-sdk

Example .env file contents. The file must be located in the directory from which the application is executed.

```plaintext
KINDE_DOMAIN=https://burntjam.kinde.com
KINDE_CLIENT_ID=<replace>
KINDE_CLIENT_SECRET=<replace>
KINDE_SCOPES=openid
KINDE_AUDIENCE=https://<replace>.kinde.com/api
```

--------------------------------

### getDecodedToken usage examples

Source: https://docs.kinde.com/developer-tools/sdks/native/expo

Examples of using getDecodedToken to get access and ID tokens, and adding custom claims.

```typescript
// Get the decoded access token
const decodedAccessToken = await getDecodedToken("accessToken");
// Get the decoded ID token
const decodedIdToken = await getDecodedToken("idToken");


// Adding custom claims to the decoded token
const decodedAccessTokenWithCustomClaims = await getDecodedToken<{
  customClaim: string;
}>("accessToken");
```

--------------------------------

### Run the project with pnpm

Source: https://docs.kinde.com/integrate/third-party-tools/kinde-supabase-todo-app

Use this command to start the development server with pnpm. After running, go to http://localhost:3000 to preview the app.

```bash
pnpm run dev
```

--------------------------------

### Get entitlement response (200)

Source: https://docs.kinde.com/kinde-apis/frontend

Example 200 response for the Get entitlement endpoint. Shows the structure of a single billing entitlement, including the feature key, price name, and entitlement limits. The `metadata` object is empty in this example.

```json
{
  "data": {
    "org_code": "org_0195ac80a14e",
    "entitlement": {
      "id": "entitlement_0195ac80a14e8d71f42b98e75d3c61ad",
      "fixed_charge": null,
      "price_name": "Seats",
      "unit_amount": null,
      "feature_key": "seats",
      "feature_name": "Seats",
      "entitlement_limit_max": 10,
      "entitlement_limit_min": null
    }
  },
  "metadata": {}
}
```

--------------------------------

### Build the Kinde Java SDK from source

Source: https://docs.kinde.com/developer-tools/sdks/backend/java-sdk

Clone the repository, navigate into it, and install dependencies to build the SDK from source.

```bash
git clone https://github.com/kinde-oss/kinde-java-sdk
```

```bash
cd kinde-java-sdk
```

```bash
mvn clean install
```

--------------------------------

### GetClient - get authenticated HTTP client

Source: https://docs.kinde.com/developer-tools/sdks/backend/go-sdk

Returns an *http.Client pre-configured with the device flow's access token. Refreshes automatically when the token expires if WithOffline() was set. The example makes a GET request to an example API endpoint.

```go
client, err := deviceFlow.GetClient(context.Background())
if err != nil {
    log.Fatalf("failed to get client: %v", err)
}


resp, err := client.Get("https://api.example.com/data")

```

--------------------------------

### Create main.js with Electron main process setup

Source: https://docs.kinde.com/developer-tools/guides/kinde-and-electron

This snippet shows the contents of main.js, which sets up the Electron main process for Kinde authentication. It imports required modules, configures callback and logout redirect URIs, initializes a token verifier, and defines a token store using safeStorage for OS-encrypted file storage. It also includes helper functions for stamping token issuance times and posting form data to token endpoints.

```bash
touch main.js
```

```javascript
const { app, BrowserWindow, ipcMain, shell, safeStorage } = require("electron")
const path = require("path")
const fs = require("fs")
const express = require("express")


const {
  generateVerifier,
  challengeFromVerifier,
  randomState,
  decodeIdToken,
  createTokenVerifier,
} = require("./helpers")


const config = require("./kinde.config")


// ---------- Config ----------
const CALLBACK_HOST = "127.0.0.1"
const CALLBACK_PORT = 53180
const REDIRECT_URI = `http://${CALLBACK_HOST}:${CALLBACK_PORT}/callback`
const LOGOUT_REDIRECT_URI = `http://${CALLBACK_HOST}:${CALLBACK_PORT}/logout-complete`


const ISSUER = config.issuerUrl
const CLIENT_ID = config.clientId
const AUDIENCE = config.audience || ""
const SCOPES = (config.scopes || "openid profile email offline").trim()


if (!ISSUER || !CLIENT_ID || ISSUER.includes("<") || CLIENT_ID.includes("<")) {
  console.error("Please configure kinde.config.js with your Kinde credentials")
}


// ---------- Token verifier (JWKS-backed, initialized once at startup) ----------
const verifyToken = createTokenVerifier(ISSUER, AUDIENCE || undefined)


// ---------- Token storage (safeStorage + OS-encrypted file) ----------
function getStorePath() {
  return path.join(app.getPath("userData"), "kinde-tokens.enc")
}


const tokenStore = {
  async load() {
    try {
      const p = getStorePath()
      if (!fs.existsSync(p) || !safeStorage.isEncryptionAvailable()) return null
      const encrypted = fs.readFileSync(p)
      const json = safeStorage.decryptString(encrypted)
      const t = JSON.parse(json)
      if (!t || typeof t.access_token !== "string") return null
      return t
    } catch {
      return null
    }
  },
  async save(tokens) {
    if (!safeStorage.isEncryptionAvailable()) {
      throw new Error("OS encryption is not available")
    }
    const encrypted = safeStorage.encryptString(JSON.stringify({ ...tokens }))
    fs.writeFileSync(getStorePath(), encrypted)
  },
  async clear() {
    try {
      const p = getStorePath()
      if (fs.existsSync(p)) fs.unlinkSync(p)
    } catch {}
  },
  async exists() {
    return fs.existsSync(getStorePath())
  },
}


// ---------- Small helpers ----------
function stampIssued(tokens) {
  const t = { ...tokens }
  t.issued_at = Date.now()
  if (typeof t.expires_in === "number")
    t.expires_at = t.issued_at + t.expires_in * 1000
  return t
}


async function postForm(url, data) {
  const body = new URLSearchParams(data)
  const res = await fetch(url, {
    method: "POST",
    headers: { "Content-Type": "application/x-www-form-urlencoded" },
    body,
  })
  const text = await res.text()
  if (!res.ok) throw new Error(`${res.status} ${text}`)
  return JSON.parse(text)
}
```

--------------------------------

### kinde.json example configuration

Source: https://docs.kinde.com/workflows/configuration/kinde-json

Example kinde.json file showing the rootDir, version, and integrations options. Place this file in your project's root directory.

```json
{
  "rootDir": "kindeSrc",
  "version": "2024-12-09",
  "integrations": {"npm": {"enabled": true}}
}
```

--------------------------------

### getUserOrganizations - Get all organizations for user

Source: https://docs.kinde.com/developer-tools/sdks/backend/tsr-sdk

Gets all organizations the user has access to. The output example shows the returned array of org codes.

```typescript
import { getUserOrganizations } from "@kinde/tsr/server"


const orgs = await getUserOrganizations()
```

```json
["org_1234", "org_5678"]
```

--------------------------------

### Install Next.js starter kit dependencies

Source: https://docs.kinde.com/developer-tools/sdks/backend/nextjs-sdk

Run this command in the root of your project to install the dependencies for the Next.js starter kit. Requires Node.js version 20 or higher.

```bash
cd kinde-nextjs-app-router-starter
npm install
```

--------------------------------

### Get industries - response

Source: https://docs.kinde.com/kinde-apis/management

Example 200 response for the Get industries endpoint. Shows a success message and a list of industries with their keys and names.

```json
{
  "code": "OK",
  "message": "Success",
  "industries": [
    {
      "key": "administration_office_support",
      "name": "Administration & Office Support"
    }
  ]
}
```

--------------------------------

### Get API keys - response

Source: https://docs.kinde.com/kinde-apis/management

Example response for a successful GET /api/v1/api_keys request. Shows the structure of the returned API keys array.

```json
{
  "code": "OK",
  "message": "Success",
  "has_more": true,
  "api_keys": [
    {
      "id": "api_key_0195ac80a14e8d71f42b98e75d3c61ad",
      "name": "My API Key",
      "type": "organization",
      "status": "active",
      "key_prefix": "kinde_",
      "key_suffix": "abcd",
      "created_on": "2024-11-18T13:32:03+11",
      "last_verified_on": "2024-11-18T13:32:03+11",
      "last_verified_ip": "192.168.1.1",
      "created_by": "John Doe",
      "api_ids": [
        "api_123",
        "api_456"
      ],
      "scopes": [
        "read:users",
        "write:users"
      ]
    }
  ]
}
```

--------------------------------

### Create lib directory and prisma.ts file

Source: https://docs.kinde.com/integrate/third-party-tools/kinde-nextjs-prisma

Create the lib directory and the prisma.ts file.

```bash
mkdir src/lib && touch src/lib/prisma.ts
```

--------------------------------

### Deployment output

Source: https://docs.kinde.com/developer-tools/guides/deploy-on-cloudflare-workers

Example output after deploying, showing the uploaded app and the URL to access it.

```text
Uploaded my-app (.. sec)
Deployed my-app triggers (.. sec)
https://<your-app-name>.<your-account-name>.workers.dev
```

--------------------------------

### getUserOrganizations usage

Source: https://docs.kinde.com/developer-tools/sdks/frontend/react-sdk

Gets an array of all organizations the user has access to. The example shows a button that triggers an async function to get and log the organizations.

```javascript
const { getUserOrganizations } = useKindeAuth();


const runAsyncFunction =  async () => {
  const orgs = await getUserOrganizations();
  console.log(orgs);
}


<button onClick={runAsyncFunction}>Get User Organizations</button>
```

```json
["org_1234", "org_5678"]
```

--------------------------------

### Install @kinde-oss/kinde-auth-sveltekit with yarn

Source: https://docs.kinde.com/developer-tools/sdks/backend/sveltekit-sdk

Install the Kinde SvelteKit SDK using yarn.

```bash
yarn add @kinde-oss/kinde-auth-sveltekit
```

--------------------------------

### Get properties response schema

Source: https://docs.kinde.com/kinde-apis/frontend

Example response body returned by the Get properties endpoint. Contains a data object with an array of property objects.

```json
{
  "data": {
    "properties": [
      {
        "id": "prop_0195ac80a14e8d71f42b98e75d3c61ad"
      }
    ]
  }
}
```

--------------------------------

### Install @kinde-oss/kinde-auth-sveltekit with npm

Source: https://docs.kinde.com/developer-tools/sdks/backend/sveltekit-sdk

Install the Kinde SvelteKit SDK using npm.

```bash
npm i @kinde-oss/kinde-auth-sveltekit
```

--------------------------------

### getOrganization usage

Source: https://docs.kinde.com/developer-tools/sdks/frontend/react-sdk

Get the ID of the organization your user is signed into. The example shows a button that triggers an async function to get and log the organization ID.

```javascript
const { getOrganization } = useKindeAuth();


const runAsyncFunction =  async () => {
  const org = await getOrganization();
  console.log(org);
}
<button onClick={runAsyncFunction}>Get Organization</button>
```

```text
org_1234
```

--------------------------------

### Create Cypress API setup directory and file

Source: https://docs.kinde.com/testing/cypress/test-backend-apis

Creates the cypress/e2e/api directory and an empty api.setup.js file for the API setup.

```bash
mkdir -p cypress/e2e/api
touch cypress/e2e/api/api.setup.js

```

--------------------------------

### getClaim usage

Source: https://docs.kinde.com/developer-tools/sdks/frontend/react-sdk

Get a single claim from an access or ID token. The example shows a button that triggers an async function to get and log the claim.

```typescript
claim: string, tokenKey?: "accessToken" | "idToken"
```

```javascript
const { getClaim } = useKindeAuth();


const runAsyncFunction =  async () => {
  const claim = await getClaim("given_name", "idToken");
  console.log(claim);
}


<button onClick={runAsyncFunction}>Get Claim</button>
```

--------------------------------

### getCurrentOrganization - Get current org code

Source: https://docs.kinde.com/developer-tools/sdks/backend/tsr-sdk

Gets the org code of the organization the user is currently signed into. The output example shows the returned string.

```typescript
import { getCurrentOrganization } from "@kinde/tsr/server"


const org = await getCurrentOrganization()
```

```text
org_1234
```

--------------------------------

### Run the project with yarn

Source: https://docs.kinde.com/integrate/third-party-tools/kinde-supabase-todo-app

Use this command to start the development server with yarn. After running, go to http://localhost:3000 to preview the app.

```bash
yarn run dev
```

--------------------------------

### Create jest.global-setup.js

Source: https://docs.kinde.com/testing/test-backend-apis-jest

Create the jest.global-setup.js file.

```bash
touch jest.global-setup.js
```

--------------------------------

### GET /api/v1/users response example

Source: https://docs.kinde.com/authenticate/enterprise-connections/mapping-users-enterprise

Example JSON response from the Kinde API endpoint GET /api/v1/users, showing the structure of the users array with fields like id, provided_id, email, and identities. The id field is the Kinde user ID, and provided_id is the ID you may have provided when importing users.

```json
{
  "code": "string",
  "message": "string",
  "users": [
    {
      "id": "string",
      "provided_id": "string",
      "email": "string",
      "username": "string",
      "last_name": "string",
      "first_name": "string",
      "is_suspended": true,
      "picture": "string",
      "total_sign_ins": 0,
      "failed_sign_ins": 0,
      "last_signed_in": "string",
      "created_on": "string",
      "organizations": ["string"],
      "identities": [
        {
          "type": "string",
          "identity": "string"
        }
      ]
    }
  ],
  "next_token": "string"
}
```

--------------------------------

### GET /some-route

Source: https://docs.kinde.com/developer-tools/sdks/backend/express-sdk

Example of protecting an Express endpoint with the JWT verifier middleware.

```APIDOC
## [GET] /some-route

### Description
Protect an endpoint by adding the verifier middleware. If the token is valid, the user's Kinde ID is added to the request; otherwise, a 403 error is thrown.

### Method
GET

### Endpoint
/some-route

### Parameters
#### Middleware
- **verifier** (function) - Required - The JWT verifier middleware to validate the token.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **req.user** (object) - Contains the user's Kinde ID, e.g., `{id: 'kp:the-users-kinde-id'}`.

#### Response Example
```json
{
  "id": "kp:the-users-kinde-id"
}
```

#### Error Response (403)
- Thrown if the token is invalid.
```

--------------------------------

### Install @kinde-oss/kinde-auth-sveltekit with pnpm

Source: https://docs.kinde.com/developer-tools/sdks/backend/sveltekit-sdk

Install the Kinde SvelteKit SDK using pnpm.

```bash
pnpm add @kinde-oss/kinde-auth-sveltekit
```

--------------------------------

### Example .env with custom API path and login route

Source: https://docs.kinde.com/developer-tools/sdks/backend/nextjs-sdk

Example environment variables to customize the Kinde Auth API path and login route.

```env
KINDE_AUTH_API_PATH="/my/custom/path"
KINDE_AUTH_LOGIN_ROUTE="app_login"
```

--------------------------------

### getCurrentOrganization usage

Source: https://docs.kinde.com/developer-tools/sdks/frontend/react-sdk

Get the ID of the organization your user is signed into. This is an alias for getOrganization. The example shows a button that triggers an async function to get and log the organization ID.

```javascript
const { getCurrentOrganization } = useKindeAuth();


const runAsyncFunction =  async () => {
  const org = await getCurrentOrganization();
  console.log(org);
}
<button onClick={runAsyncFunction}>Get Current Organization</button>
```

```text
org_1234
```

--------------------------------

### Install JWT Bearer and OpenID Connect packages

Source: https://docs.kinde.com/developer-tools/your-apis/dotnet-based-apis

Install the packages that handle tokens for .NET authentication.

```bash
dotnet add package Microsoft.AspNetCore.Authentication.JwtBearer
dotnet add package Microsoft.IdentityModel.Protocols.OpenIdConnect
```

--------------------------------

### getFlag usage

Source: https://docs.kinde.com/developer-tools/sdks/frontend/react-sdk

Get a feature flag value from the feature_flags claim of the access token. The example shows a button that triggers an async function to get and log the flag.

```typescript
code: string, options?: { defaultValue?: string | boolean | number; type?: "string" | "boolean" | "number"; }
```

```javascript
const { getFlag } = useKindeAuth();


const runAsyncFunction =  async () => {
  const flag = await getFlag("theme");
  console.log(flag);
}


<button onClick={runAsyncFunction}>Get Flag</button>
```

```json
{
  "code": "theme",
  "type": "string",
  "value": "pink",
  "is_default": false
}
```
Tokens:
Raw