Integration Guide

Connect your applications to OpenGate IAM using standard OAuth 2.1 / OIDC — compatible with any language or framework.

On this page

• Integration Patterns
• Quick Integration Checklist

Integration Patterns

┌─────────────────────────────────────────────────────────────────────┐
│                    Integration Patterns                             │
│                                                                     │
│  ┌──────────────────────────┐   ┌───────────────────────────────┐   │
│  │  Browser SPA / Mobile    │   │    Backend / Microservice     │   │
│  │                          │   │                               │   │
│  │  Auth Code + PKCE        │   │  Client Credentials Grant     │   │
│  │  → opengate-console      │   │  → opengate-admin-api         │   │
│  │  → Your React app        │   │  → Your backend service       │   │
│  │  → Your mobile app       │   │                               │   │
│  └──────────────────────────┘   └───────────────────────────────┘   │
│                                                                     │
│  ┌──────────────────────────┐   ┌───────────────────────────────┐   │ 
│  │   Spring Boot API        │   │    Next.js (Full-stack)       │   │
│  │                          │   │                               │   │
│  │  OAuth2 Resource Server  │   │  next-auth / Auth.js          │   │ 
│  │  JWT validation via JWKS │   │  Server-side session mgmt     │   │
│  └──────────────────────────┘   └───────────────────────────────┘   │
└─────────────────────────────────────────────────────────────────────┘

Quick Integration Checklist

• Register your app as an OAuth2 client in the Admin Console
• Note your client_id (and client_secret for confidential clients)
• Fetch the OIDC discovery document: GET /realms/{realm}/.well-known/openid-configuration
• Implement Authorization Code + PKCE for browser apps
• Validate JWTs using the jwks_uri from the discovery document
• Handle token refresh before expiry (access token: 5 min)