JBoss.orgCommunity Documentation

Keycloak Reference Guide

SSO for Web Apps and REST Services

1.0-beta-1


Preface
1. License
2. Overview
2.1. Key Concepts in Keycloak
2.2. How Does Security Work in Keycloak?
2.2.1. Permission Scopes
3. Installation and Configuration of Keycloak Server
3.1. Appliance Install
3.2. WAR Distribution Installation
3.3. Configuring the Server
3.3.1. Database Configuration
3.3.2. MongoDB based model
3.3.3. AS7/EAP6.x Logging
3.3.4. SSL/HTTPS Setup
4. Running Keycloak Server on OpenShift
4.1. Create Keycloak instance with the web tool
4.2. Create Keycloak instance with the command-line tool
4.3. Next steps
5. Master Admin Access Control
5.1. Global Roles
5.2. Realm Specific Roles
6. Per Realm Admin Access Control
6.1. Realm Roles
7. Adapters
7.1. General Adapter Config
7.2. JBoss/Wildfly Adapter
7.2.1. Adapter Installation
7.2.2. Per WAR Configuration
7.2.3. Securing WARs via Keycloak Subsystem
7.3. Pure Client Javascript Adapter
7.3.1. Session status iframe
7.3.2. JavaScript Adapter reference
7.4. Installed Applications
7.4.1. http://localhost
7.4.2. urn:ietf:wg:oauth:2.0:oob
8. Social
8.1. Social Login Config
8.1.1. Enable social login
8.1.2. Social-only login
8.1.3. Social Callback URL
8.2. Facebook
8.3. GitHub
8.4. Google
8.5. Twitter
8.6. Social Provider SPI
9. Themes
9.1. Configure theme
9.2. Default themes
9.3. Creating a theme
9.3.1. Stylesheets
9.3.2.
9.3.3. Images
9.3.4. Messages
9.3.5. Modifying HTML
9.4. SPIs
9.4.1. Theme SPI
9.4.2. Account SPI
9.4.3. Login SPI
10. Email
10.1. Email Server Config
10.1.1. Enable SSL or TLS
10.1.2. Authentication
11. Application and Client Access Types
12. Roles
12.1. Composite Roles
13. Direct Access Grants
14. CORS
15. Cookie settings, Session Timeouts, and Token Lifespans
15.1. Remember Me
15.2. Session Timeouts
15.3. Token Timeouts
16. Admin REST API
17. Audit
17.1. Events
17.2. Audit Listener
17.3. Audit Provider
17.4. Configure Audit Settings for Realm
18. Authentication SPI
18.1. Available Authentication Providers
18.2. Features and configuration
18.3. Creating your own Authentication Provider
19. LDAP Integration
20. Export and Import
21. Migration from older versions
21.1. Migrating from 1.0 Alpha 4 to Beta 1
21.2. Migrating from 1.0 Alpha 2 to Alpha 3
21.3. Migrating from 1.0 Alpha 1 to Alpha 2