Logto

https://docs.logto.io/
Admin
Logto is an identity and access management (IAM) solution for modern apps and SaaS products,...
Tokens:591,218
Snippets:4,679
Trust Score:8.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Basic Echo server setup (main.go)

Source: https://docs.logto.io/api-protection/go/echo

Basic Echo server setup that starts an HTTP server on port 3000. Save this as main.go and run it after initializing the project.

```go
package main  
  
import (  
    "github.com/labstack/echo/v4"  
)  
  
func main() {  
    e := echo.New()  
  
    e.Logger.Fatal(e.Start(":3000"))  
}  

```

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

### Install Logto Go SDK packages

Source: https://docs.logto.io/quick-starts/go

Install the Logto Go SDK core and client packages using go get.

```bash
# Install the core package for accessing predefined values and types  

go get github.com/logto-io/go/v2/core  

  

# Install the client package for interacting with the Logto  

go get github.com/logto-io/go/v2/client  

```

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

### Initialize Go project with Echo

Source: https://docs.logto.io/api-protection/go/echo

Initializes a new Go module and installs the Echo web framework. Run these commands in your project directory before creating the server setup.

```bash
go mod init your-api-name  

go get github.com/labstack/echo/v4  

```

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

### Interactive installation with npm init @logto@latest

Source: https://docs.logto.io/logto-oss/using-cli/install-logto

Run this command in your terminal to start an interactive installation of Logto using npm.

```bash
npm init @logto@latest
```

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

### Interactive installation with logto init

Source: https://docs.logto.io/logto-oss/using-cli/install-logto

Run this command in your terminal to start an interactive installation of Logto using the CLI.

```bash
logto init
```

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

### Initialize Laravel project with installer

Source: https://docs.logto.io/api-protection/php/laravel

Use the Laravel installer to create a new Laravel project. Run these commands in order: install the installer globally, create the project, and change into the project directory.

```bash
composer global require laravel/installer  

laravel new your-api-name  

cd your-api-name  

```

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

### Install Auth.js with npm

Source: https://docs.logto.io/quick-starts/next-auth

Install the beta version of next-auth using npm.

```bash
npm i next-auth@beta
```

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

### Install Auth.js with yarn

Source: https://docs.logto.io/quick-starts/next-auth

Install the beta version of next-auth using yarn.

```bash
yarn add next-auth@beta
```

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

### Install Permit.io SDK

Source: https://docs.logto.io/integrations/permit.io

Installs the Permit.io SDK in your Next.js application.

```bash
npm install permitio  
```

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

### Initialize Go project and install Gin

Source: https://docs.logto.io/api-protection/go/gin

Initializes a new Go module and installs the Gin web framework. Run these commands in your project directory before creating the server.

```bash
go mod init your-api-name  

go get github.com/gin-gonic/gin  

```

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

### Get OIDC private keys (CLI)

Source: https://docs.logto.io/logto-oss/using-cli/manage-database-configs

Example of using `logto db config get` to retrieve the OIDC private keys.

```bash
logto db config get oidc.privateKeys
```

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

### Show Logto system configuration help

Source: https://docs.logto.io/logto-oss/file-storage-provider

Use the CLI help command to explore configuration options for the storage provider.

```bash
pnpm logto db system --help  
```

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

### Output of get oidc.privateKeys

Source: https://docs.logto.io/logto-oss/using-cli/manage-database-configs

Example output of the `logto db config get oidc.privateKeys` command, showing the retrieved value as a JSON array.

```text
oidc.privateKeys=["\n-----BEGIN PRIVATE KEY-----\nMIIJRAIBA..."]
```

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

### Initialize Django project with django-admin startproject

Source: https://docs.logto.io/api-protection/python/django

Use Django's built-in commands to create a new project and navigate into its directory.

```bash
django-admin startproject your_api_name  

cd your_api_name  

```

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

### Initialize Go project and install Chi

Source: https://docs.logto.io/api-protection/go/chi

Initializes a new Go module and installs the Chi router package. Run these commands in your project directory before setting up the server.

```bash
go mod init your-api-name  

go get github.com/go-chi/chi/v5  

```

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

### Get OIDC private keys (npx)

Source: https://docs.logto.io/logto-oss/using-cli/manage-database-configs

Example of using `npx @logto/cli db config get` to retrieve the OIDC private keys.

```bash
npx @logto/cli db config get oidc.privateKeys
```

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

### Initialize Node.js project and install Fastify

Source: https://docs.logto.io/api-protection/nodejs/fastify

Initializes a new Node.js project and installs Fastify. Run these commands in your project directory before setting up the server.

```bash
npm init -y  

npm install fastify  

```

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

### Install firebase/php-jwt via Composer

Source: https://docs.logto.io/api-protection/php/laravel

Install the firebase/php-jwt library using Composer, which is used to validate JWTs in the Laravel API protection guide.

```bash
composer require firebase/php-jwt
```

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

### Install jwx library for JWT validation

Source: https://docs.logto.io/api-protection/go/gin

Initialize a Go module and install the github.com/lestrrat-go/jwx/v3 library, which is used to validate JWTs in the Logto API protection guide.

```bash
go mod init your-project  

go get github.com/lestrrat-go/jwx/v3  
```

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

### Create basic Fiber server (main.go)

Source: https://docs.logto.io/api-protection/go/fiber

Basic Fiber server setup that creates a new app and listens on port 3000. Save as main.go.

```go
package main  
  
import (  
    "log"  
  
    "github.com/gofiber/fiber/v2"  
)  
  
func main() {  
    app := fiber.New()  
  
    log.Fatal(app.Listen(":3000"))  
}  

```

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

### Response body for GET /api/my-account

Source: https://docs.logto.io/end-user-flows/account-settings/by-account-api

Example JSON response from the GET /api/my-account endpoint. The fields shown are illustrative and may vary depending on account center settings.

```json
{
  "id": "...",
  "username": "...",
  "name": "...",
  "avatar": "..."
}
```

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

### Initialize Node.js project and install Express

Source: https://docs.logto.io/api-protection/nodejs/express

Initializes a new Node.js project and installs Express. Run these commands in your project directory before setting up the server.

```bash
npm init -y  

npm install express  

```

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

### MainVerticle.java - basic Vert.x Web server

Source: https://docs.logto.io/api-protection/java/vertx-web

MainVerticle.java defines a Vert.x Web server with a router, BodyHandler, and a GET /hello route. Starts an HTTP server on port 3000 and completes the start promise on success.

```java
package com.example;

import io.vertx.core.AbstractVerticle;
import io.vertx.core.Promise;
import io.vertx.ext.web.Router;
import io.vertx.ext.web.handler.BodyHandler;

public class MainVerticle extends AbstractVerticle {

    @Override
    public void start(Promise<Void> startPromise) throws Exception {
        Router router = Router.router(vertx);

        router.route().handler(BodyHandler.create());

        router.get("/hello").handler(ctx -> {
            ctx.response()
                .putHeader("content-type", "text/plain")
                .end("Hello from Vert.x Web!");
        });

        vertx.createHttpServer()
            .requestHandler(router)
            .listen(3000, http -> {
                if (http.succeeded()) {
                    startPromise.complete();
                    System.out.println("HTTP server started on port 3000");
                } else {
                    startPromise.fail(http.cause());
                }
            });
    }
}
```

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

### Organization.Membership.Updated webhook payloads

Source: https://docs.logto.io/developers/webhooks/webhooks-request

Example payloads for the Organization.Membership.Updated webhook event, covering add, replace, remove, no-op, and bulk operations. The bulk example shows a 5000-entry cap that silently truncates; seeing exactly 5000 entries should prompt a reconciling GET request.

```json
{  
  "event": "Organization.Membership.Updated",  
  "organizationId": "org_abc",  
  "addedUserIds": ["u_001"]  
}  
```

```json
{  
  "event": "Organization.Membership.Updated",  
  "organizationId": "org_abc",  
  "addedUserIds": ["u_002"],  
  "removedUserIds": ["u_001"]  
}  
```

```json
{  
  "event": "Organization.Membership.Updated",  
  "organizationId": "org_abc",  
  "removedUserIds": ["u_001"]  
}  
```

```json
{  
  "event": "Organization.Membership.Updated",  
  "organizationId": "org_abc",  
  "addedApplicationIds": ["app_xyz"]  
}  
```

```json
{  
  "event": "Organization.Membership.Updated",  
  "organizationId": "org_abc"  
}  
```

```json
{  
  "event": "Organization.Membership.Updated",  
  "organizationId": "org_abc",  
  "removedUserIds": ["u_0001", "u_0002", "/* … exactly 5000 entries total */"]  
}  
```

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

### Create project and install dependencies

Source: https://docs.logto.io/use-cases/ai/mcp-server-add-auth

Creates the project directory, initializes an npm package, sets ESM and entry point, and installs the MCP SDK v2, Express adapters, and mcp-auth. Requires Node.js >= 20.

```bash
mkdir mcp-server  

cd mcp-server  

npm init -y  

npm pkg set type="module"  

npm pkg set main="whoami.js"  

npm pkg set scripts.start="node whoami.js"  

npm install @modelcontextprotocol/server @modelcontextprotocol/express @modelcontextprotocol/node express mcp-auth  

```

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

### Create basic Fastify server (app.ts)

Source: https://docs.logto.io/api-protection/nodejs/fastify

Basic Fastify server setup that listens on port 3000 with logging enabled. If the server fails to start, it logs the error and exits the process.

```typescript
import fastify from 'fastify';  

  

const server = fastify({ logger: true });  

  

try {  

  await server.listen({ port: 3000 });  

  console.log('Server running on http://localhost:3000');  

} catch (err) {  

  server.log.error(err);  

  process.exit(1);  

}  

```

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

### Initialize Slim project with Composer

Source: https://docs.logto.io/api-protection/php/slim

Initializes a new Slim project directory and runs Composer init to create the project structure.

```bash
mkdir your-api-name  

cd your-api-name  

composer init  

```

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

### Install dependencies with bundle install

Source: https://docs.logto.io/api-protection/ruby/sinatra

Run bundle install to install the jwt gem and any other dependencies.

```bash
bundle install  
```

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

### Initialize Node.js project with Hapi

Source: https://docs.logto.io/api-protection/nodejs/hapi

Initializes a new Node.js project and installs the Hapi framework. Run these commands in your project directory before setting up the server.

```bash
npm init -y  

npm install @hapi/hapi  

```

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

### Install Django with pip

Source: https://docs.logto.io/api-protection/python/django

Install Django if it is not already installed.

```bash
pip install Django  

```

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

### Install Logto.AspNetCore.Authentication NuGet package

Source: https://docs.logto.io/quick-starts/dotnet-core/mvc

Run this command in the project directory to add the Logto authentication SDK. Requires .NET 6.0 or higher; the demonstration uses .NET Core 8.0.

```bash
dotnet add package Logto.AspNetCore.Authentication  
```

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

### Create tenant, get Management API token, and list applications

Source: https://docs.logto.io/logto-cloud/automate-tenant-creation

Full automation example that creates a tenant, exchanges the returned default M2M credentials for a Management API access token, and lists applications in the new tenant. Requires the LOGTO_CLOUD_PAT environment variable to be set. Throws errors if any API call fails.

```javascript
const cloudApiEndpoint = 'https://cloud.logto.io';  

const logtoCloudPat = process.env.LOGTO_CLOUD_PAT;  

  

const createTenantResponse = await fetch(`${cloudApiEndpoint}/api/tenants`, {  
  method: 'POST',  
  headers: {  
    authorization: `Bearer ${logtoCloudPat}`,  
    'content-type': 'application/json',  
  },  
  body: JSON.stringify({  
    name: 'My automated tenant',  
    tag: 'development',  
    regionName: 'EU',  
  }),  
});  

  

if (!createTenantResponse.ok) {  
  throw new Error(`Failed to create tenant: ${await createTenantResponse.text()}`);  
}  

  

const tenant = await createTenantResponse.json();  
const tenantEndpoint = tenant.indicator;  
const { id: appId, secret: appSecret } = tenant.defaultApplication;  

  

const tokenResponse = await fetch(`${tenantEndpoint}/oidc/token`, {  
  method: 'POST',  
  headers: {  
    authorization: `Basic ${Buffer.from(`${appId}:${appSecret}`).toString('base64')}`,  
    'content-type': 'application/x-www-form-urlencoded',  
  },  
  body: new URLSearchParams({  
    grant_type: 'client_credentials',  
    resource: `${tenantEndpoint}/api`,  
    scope: 'all',  
  }),  
});  

  

if (!tokenResponse.ok) {  
  throw new Error(`Failed to get Management API token: ${await tokenResponse.text()}`);  
}  

  

const { access_token: managementApiAccessToken } = await tokenResponse.json();  

  

const applicationsResponse = await fetch(`${tenantEndpoint}/api/applications`, {  
  headers: {  
    authorization: `Bearer ${managementApiAccessToken}`,  
  },  
});  

  

if (!applicationsResponse.ok) {  
  throw new Error(`Failed to list applications: ${await applicationsResponse.text()}`);  
}  

  

const applications = await applicationsResponse.json();  

  

console.log({ tenantId: tenant.id, applications });  
```

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

### Basic Chi server setup (main.go)

Source: https://docs.logto.io/api-protection/go/chi

Creates a basic Chi server that listens on port 3000. This is the minimal setup for a Go API with Chi.

```go
package main  
  
import (  
    "net/http"  
  
    "github.com/go-chi/chi/v5"  
)  
  
func main() {  
    r := chi.NewRouter()  
  
    http.ListenAndServe(":3000", r)  
}  

```
Tokens:
Raw