keycloak-scim/docbook/reference/en/en-US/master.xml

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
                         "http://www.docbook.org/xml/4.4/docbookx.dtd"
        [
                <!ENTITY License SYSTEM "modules/License.xml">
                <!ENTITY Overview SYSTEM "modules/Overview.xml">
                <!ENTITY Installation SYSTEM "modules/server-installation.xml">
                <!ENTITY OpenShift SYSTEM "modules/openshift.xml">
                <!ENTITY AdminPermissions SYSTEM "modules/admin-permissions.xml">
                <!ENTITY PerRealmAdminPermissions SYSTEM "modules/per-realm-admin-permissions.xml">
                <!ENTITY AccessTypes SYSTEM "modules/access-types.xml">
                <!ENTITY AdapterConfig SYSTEM "modules/adapter-config.xml">
                <!ENTITY JBossAdapter SYSTEM "modules/jboss-adapter.xml">
                <!ENTITY JavascriptAdapter SYSTEM "modules/javascript-adapter.xml">
                <!ENTITY TomcatAdapter SYSTEM "modules/tomcat-adapter.xml">
                <!ENTITY Jetty9Adapter SYSTEM "modules/jetty9-adapter.xml">
                <!ENTITY Jetty8Adapter SYSTEM "modules/jetty8-adapter.xml">
                <!ENTITY InstalledApplications SYSTEM "modules/installed-applications.xml">
                <!ENTITY Logout SYSTEM "modules/logout.xml">
                <!ENTITY SAML SYSTEM "modules/saml.xml">
                <!ENTITY SocialConfig SYSTEM "modules/social-config.xml">
                <!ENTITY SocialFacebook SYSTEM "modules/social-facebook.xml">
                <!ENTITY SocialGitHub SYSTEM "modules/social-github.xml">
                <!ENTITY SocialGoogle SYSTEM "modules/social-google.xml">
                <!ENTITY SocialTwitter SYSTEM "modules/social-twitter.xml">
                <!ENTITY SocialProviderSPI SYSTEM "modules/social-spi.xml">
                <!ENTITY Themes SYSTEM "modules/themes.xml">
                <!ENTITY Migration SYSTEM "modules/MigrationFromOlderVersions.xml">
                <!ENTITY Email SYSTEM "modules/email.xml">
                <!ENTITY Roles SYSTEM "modules/roles.xml">
                <!ENTITY DirectAccess SYSTEM "modules/direct-access.xml">
                <!ENTITY CORS SYSTEM "modules/cors.xml">
                <!ENTITY Timeouts SYSTEM "modules/timeouts.xml">
                <!ENTITY Events SYSTEM "modules/events.xml">
                <!ENTITY AdminApi SYSTEM "modules/admin-rest-api.xml">
                <!ENTITY UserFederation SYSTEM "modules/user-federation.xml">
                <!ENTITY ExportImport SYSTEM "modules/export-import.xml">
                <!ENTITY ServerCache SYSTEM "modules/cache.xml">
                <!ENTITY SecurityVulnerabilities SYSTEM "modules/security-vulnerabilities.xml">
                <!ENTITY Clustering SYSTEM "modules/clustering.xml">
                <!ENTITY ApplicationClustering SYSTEM "modules/application-clustering.xml">
                <!ENTITY MultiTenancy SYSTEM "modules/multi-tenancy.xml">
                ]>

<book>

   <bookinfo>
      <title>Keycloak Reference Guide</title>
      <subtitle>SSO for Web Apps and REST Services</subtitle>
      <releaseinfo>&project.version;</releaseinfo>
   </bookinfo>

   <toc/>

   <preface id="preface" revision="1">
      <title>Preface</title>
      <para>
         In some of the example listings, what is meant to be displayed on one line does not fit
         inside the available page width. These lines have been broken up. A '\' at the end of a
         line means that a break has been introduced to fit in the page, with the following lines
         indented. So:
<programlisting>
Let's pretend to have an extremely \
long line that \
does not fit
This one is short
</programlisting>
         Is really:
<programlisting>
Let's pretend to have an extremely long line that does not fit
This one is short
</programlisting>
      </para>
   </preface>

    &License;
    &Overview;
    &Installation;
    &OpenShift;
    &AdminPermissions;
    &PerRealmAdminPermissions;
    <chapter>
        <title>Adapters</title>
        <para>
            Keycloak can secure a wide variety of application types. This section defines which application
            types are supported and how to configure and install them so that you can use Keycloak to secure
            your applications.
        </para>
        &AdapterConfig;
        &JBossAdapter;
        &TomcatAdapter;
        &Jetty9Adapter;
        &Jetty8Adapter;
        &JavascriptAdapter;
        &InstalledApplications;
        &Logout;
        &MultiTenancy;
    </chapter>

    <chapter>
        <title>Social</title>
        <para>
            Keycloak makes it easy to let users log in to your application using an existing account with a social network.
            Currently Facebook, Google and Twitter is supported with more planned for the future. There's also a Social
            Provider SPI that makes it relatively simple to add additional social networks.
        </para>
        &SocialConfig;
        &SocialFacebook;
        &SocialGitHub;
        &SocialGoogle;
        &SocialTwitter;
        &SocialProviderSPI;
    </chapter>

    &Themes;

    <chapter>
        <title>Email</title>
        <para>
            Keycloak sends emails to users to verify their email address. Emails are also used to allow users to
            safely restore their username and passwords.
        </para>
        &Email;
    </chapter>
    &AccessTypes;
    &Roles;
    &DirectAccess;
    &CORS;
    &Timeouts;
    &AdminApi;
    &Events;
    &UserFederation;
    &ExportImport;
    &ServerCache;
    &SAML;
    &SecurityVulnerabilities;
    &Clustering;
    &ApplicationClustering;
    &Migration;

</book>