Introduction

Introduction

This guide covers how to integrate your applications with Keycloak instances managed by Skycloak. While Skycloak handles the infrastructure and management of your Keycloak clusters, you’ll use standard Keycloak integration patterns to connect your applications.

Integration Methods

Standard Protocols

  • OpenID Connect (OIDC) - Recommended for most web and mobile applications
  • SAML 2.0 - For enterprise applications requiring SAML support
  • OAuth 2.0 - For API authorization
  • WebAuthn - For passwordless authentication

Official Keycloak Adapters

  • Keycloak Node.js Adapter
  • Keycloak Spring Boot Adapter
  • Keycloak JavaScript Adapter
  • Other official adapters

Alternative Approaches

  • Generic OpenID Connect libraries
  • Custom implementations using Keycloak REST APIs
  • Third-party OAuth 2.0/OIDC libraries

Frameworks

Server-Side

  • Node.js/Express
  • Spring Boot
  • Django
  • Laravel
  • .NET Core

Frontend

  • React
  • Angular
  • Vue.js
  • Next.js
  • Plain JavaScript

Mobile

  • Android (using AppAuth)
  • iOS (using AppAuth)
  • React Native
  • Flutter

Common Patterns

Web Applications

  • Browser-based authentication
  • Backend-for-frontend pattern
  • Direct grant access
  • Service accounts

API Security

  • Bearer token authentication
  • Introspection endpoint
  • User-managed access (UMA)
  • Resource-based authorization

Enterprise Patterns

  • Single Sign-On (SSO)
  • Identity brokering
  • Token exchange
  • Client-to-client communication

Best Practices

Security

  • Always use HTTPS
  • Implement PKCE for public clients
  • Secure token storage
  • Regular security updates
  • Proper scope usage

Performance

  • Token caching
  • Minimizing token size
  • Efficient role checking
  • Proper session management

Development

  • Use official adapters when available
  • Implement proper error handling
  • Follow OAuth 2.0 best practices
  • Test with multiple token types

Getting Started

  1. Get your Keycloak connection details from Skycloak dashboard
  2. Choose the appropriate adapter or library for your platform
  3. Configure your client in Keycloak
  4. Implement the authentication flow
  5. Test the integration