CINXE.COM
Documentation - Keycloak
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"/> <title>Documentation - Keycloak</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="description" content="Keycloak is an open source identity and access management solution"> <meta name="author" content="Keycloak Team"> <meta name="keywords" content="sso,idm,openid connect,saml,kerberos,ldap"> <link href="https://www.keycloak.org/resources/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet"> <link href="https://www.keycloak.org/resources/@fortawesome/fontawesome-free/css/all.min.css" rel="stylesheet"> <link href="https://www.keycloak.org/resources/css/keycloak.css" rel="stylesheet"> <link rel="canonical" href="https://www.keycloak.org/documentation"> <link rel="shortcut icon" href="https://www.keycloak.org/resources/favicon.ico"> <script src="https://www.keycloak.org/resources/js/ga.js" type="text/javascript"></script> <script src="https://www.keycloak.org/resources/bootstrap/dist/js/bootstrap.min.js" type="text/javascript"></script> <script src="https://www.keycloak.org/resources/tocbot/dist/tocbot.min.js" type="text/javascript"></script></head> <body> <header class="navbar navbar-expand-md bg-light shadow-sm"> <nav class="container-xxl flex-wrap flex-md-no-wrap navbar-light"> <a class="navbar-brand me-3 me-md-4 me-lg-5" href="https://www.keycloak.org/"> <img class="img-fluid" src="https://www.keycloak.org/resources/images/logo.svg" width="240" alt="Keycloak"/> </a> <a class="nav-link d-none d-sm-block d-md-none d-lg-block" href="https://github.com/keycloak/keycloak"><img src="https://img.shields.io/github/stars/keycloak/keycloak?label=GitHub%20Stars" style="height: 25px" alt="GitHub stars"/></a> <a class="nav-link d-block d-sm-none d-md-block d-lg-none" href="https://github.com/keycloak/keycloak"><img src="https://img.shields.io/github/stars/keycloak/keycloak?label=" style="height: 25px" alt="GitHub stars"/></a> <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation"> <span class="fa fa-bars fa-lg px-1 py-2"></span> </button> <div class="collapse navbar-collapse" id="navbarCollapse"> <ul class="navbar-nav flex-row flex-wrap bd-navbar-nav pt-2 py-md-0"> <li class="nav-item col-6 col-md-auto"> <a class="nav-link " href="https://www.keycloak.org/guides">Guides</a> </li> <li class="nav-item col-6 col-md-auto"> <a class="nav-link active" href="https://www.keycloak.org/documentation">Docs</a> </li> <li class="nav-item col-6 col-md-auto"> <a class="nav-link " href="https://www.keycloak.org/downloads">Downloads</a> </li> <li class="nav-item col-6 col-md-auto"> <a class="nav-link " href="https://www.keycloak.org/community">Community</a> </li> <li class="nav-item col-6 col-md-auto"> <a class="nav-link " href="https://www.keycloak.org/blog">Blog</a> </li> </ul> </div> </nav> </header> <div class="container mt-5"> <h1>Documentation <span class="badge bg-primary">26.0.6</span></h1> <h2 class="mt-4">Guides</h2> <table class="table table-bordered table-striped"> <tbody> <tr> <td> <a href="https://www.keycloak.org/docs/latest/release_notes/index.html" target="_blank"> Release Notes </a> </td> <td> </td> </tr> <tr> <td> <a href="https://www.keycloak.org/guides#getting-started"> Getting Started </a> </td> <td> How to get started with Keycloak </td> </tr> <tr> <td> <a href="https://www.keycloak.org/guides#server"> Server Installation and Configuration </a> </td> <td> Installation and offline configuration of the Keycloak server </td> </tr> <tr> <td> <a href="https://www.keycloak.org/nightly/server/containers"> Server Container Image </a> </td> <td> Documentation specific to the server container image </td> </tr> <tr> <td> <a href="https://www.keycloak.org/guides#securing-apps"> Securing Applications and Services </a> </td> <td> How to secure applications and services with Keycloak </td> </tr> <tr> <td> <a href="https://www.keycloak.org/docs/latest/server_admin/index.html" target="_blank"> Server Administration </a> </td> <td> Management and runtime configuration of the Keycloak server </td> </tr> <tr> <td> <a href="https://www.keycloak.org/docs/latest/server_development/index.html" target="_blank"> Server Developer </a> </td> <td> Creating themes and providers to customize the Keycloak server </td> </tr> <tr> <td> <a href="https://www.keycloak.org/docs/latest/authorization_services/index.html" target="_blank"> Authorization Services </a> </td> <td> Centrally manage fine-grained permissions for applications and services </td> </tr> <tr> <td> <a href="https://www.keycloak.org/docs/latest/upgrading/index.html" target="_blank"> Upgrading </a> </td> <td> Upgrading Keycloak server and adapters </td> </tr> </tbody> </table> <h2 class="mt-4">API Documentation</h2> <table class="table table-bordered table-striped"> <tbody> <tr> <td> <a href="https://www.keycloak.org/docs-api/latest/javadocs/index.html" target="_blank"> JavaDoc </a> </td> <td> Documentation for Java API </td> </tr> <tr> <td> <a href="https://www.keycloak.org/docs-api/latest/rest-api/index.html" target="_blank"> Administration REST API </a> </td> <td> Documentation for the Adminstration RESTful API </td> </tr> </tbody> </table> <p><a href="documentation-archive.html">Archived releases</a></p> </div> <div class="container mt-5"> <footer class="py-3 my-4 border-top"> <p class="text-center text-muted">Keycloak is a Cloud Native Computing Foundation incubation project</p> <div class="text-center"> <img alt="Cloud Native Computing Foundation" src="https://www.keycloak.org/resources/images/cncf_logo.png"/> </div> <p class="mt-4 text-center small text-muted">© Keycloak Authors 2024. © 2024 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage">Trademark Usage page</a>.</p> </footer> </div> </body> </html>