Keycloak Docs Distribution 21.1.2 API

Packages 
Package Description
org.freedesktop  
org.keycloak  
org.keycloak.admin.client  
org.keycloak.admin.client.resource  
org.keycloak.admin.client.spi  
org.keycloak.admin.client.token  
org.keycloak.authentication  
org.keycloak.authentication.actiontoken  
org.keycloak.authentication.actiontoken.execactions  
org.keycloak.authentication.actiontoken.idpverifyemail  
org.keycloak.authentication.actiontoken.resetcred  
org.keycloak.authentication.actiontoken.updateemail  
org.keycloak.authentication.actiontoken.verifyemail  
org.keycloak.authentication.authenticators  
org.keycloak.authentication.authenticators.access  
org.keycloak.authentication.authenticators.broker  
org.keycloak.authentication.authenticators.broker.util  
org.keycloak.authentication.authenticators.browser  
org.keycloak.authentication.authenticators.challenge  
org.keycloak.authentication.authenticators.client  
org.keycloak.authentication.authenticators.conditional  
org.keycloak.authentication.authenticators.directgrant  
org.keycloak.authentication.authenticators.resetcred  
org.keycloak.authentication.authenticators.sessionlimits  
org.keycloak.authentication.authenticators.util  
org.keycloak.authentication.authenticators.x509  
org.keycloak.authentication.forms  
org.keycloak.authentication.otp  
org.keycloak.authentication.requiredactions  
org.keycloak.authentication.requiredactions.util  
org.keycloak.authorization
Fine-grained Authorization SPI.
org.keycloak.authorization.admin  
org.keycloak.authorization.admin.representation  
org.keycloak.authorization.attribute
Provides classes related with the representation of attributes and their manipulation.
org.keycloak.authorization.authorization  
org.keycloak.authorization.client  
org.keycloak.authorization.client.representation  
org.keycloak.authorization.client.resource  
org.keycloak.authorization.client.util  
org.keycloak.authorization.common  
org.keycloak.authorization.config  
org.keycloak.authorization.identity
Provides classes related with the representation and management of identities.
org.keycloak.authorization.jpa.entities  
org.keycloak.authorization.jpa.store  
org.keycloak.authorization.model
Provides the domain model and any other type related with it
org.keycloak.authorization.permission  
org.keycloak.authorization.permission.evaluator  
org.keycloak.authorization.policy.evaluation
Provides classes related with the evaluation of policies.
org.keycloak.authorization.policy.provider
Provides classes and a SPI to plug different policy providers.
org.keycloak.authorization.policy.provider.aggregated  
org.keycloak.authorization.policy.provider.client  
org.keycloak.authorization.policy.provider.clientscope  
org.keycloak.authorization.policy.provider.group  
org.keycloak.authorization.policy.provider.js  
org.keycloak.authorization.policy.provider.permission  
org.keycloak.authorization.policy.provider.regex  
org.keycloak.authorization.policy.provider.role  
org.keycloak.authorization.policy.provider.time  
org.keycloak.authorization.policy.provider.user  
org.keycloak.authorization.protection  
org.keycloak.authorization.protection.introspect  
org.keycloak.authorization.protection.permission  
org.keycloak.authorization.protection.policy  
org.keycloak.authorization.protection.resource  
org.keycloak.authorization.store
Provides classes and a SPI to plug different metadata storage implementations.
org.keycloak.authorization.store.syncronization  
org.keycloak.authorization.util  
org.keycloak.broker.oidc  
org.keycloak.broker.oidc.mappers  
org.keycloak.broker.provider  
org.keycloak.broker.provider.mappersync  
org.keycloak.broker.provider.util  
org.keycloak.broker.saml  
org.keycloak.broker.saml.mappers  
org.keycloak.broker.social  
org.keycloak.cluster  
org.keycloak.cluster.infinispan  
org.keycloak.common  
org.keycloak.common.constants  
org.keycloak.common.crypto  
org.keycloak.common.enums  
org.keycloak.common.profile  
org.keycloak.common.util  
org.keycloak.common.util.reflections  
org.keycloak.component  
org.keycloak.config  
org.keycloak.connections.httpclient  
org.keycloak.connections.infinispan  
org.keycloak.connections.jpa  
org.keycloak.connections.jpa.entityprovider  
org.keycloak.connections.jpa.updater  
org.keycloak.connections.jpa.updater.liquibase  
org.keycloak.connections.jpa.updater.liquibase.conn  
org.keycloak.connections.jpa.updater.liquibase.custom  
org.keycloak.connections.jpa.updater.liquibase.lock  
org.keycloak.connections.jpa.updater.liquibase.log  
org.keycloak.connections.jpa.util  
org.keycloak.constants  
org.keycloak.credential  
org.keycloak.credential.hash  
org.keycloak.crypto  
org.keycloak.device  
org.keycloak.dom.saml.common  
org.keycloak.dom.saml.v1.assertion  
org.keycloak.dom.saml.v1.protocol  
org.keycloak.dom.saml.v2  
org.keycloak.dom.saml.v2.ac  
org.keycloak.dom.saml.v2.ac.classes  
org.keycloak.dom.saml.v2.assertion
Package for the model classes for the SAML2 Assertion
org.keycloak.dom.saml.v2.mdattr  
org.keycloak.dom.saml.v2.mdui  
org.keycloak.dom.saml.v2.metadata  
org.keycloak.dom.saml.v2.profiles.attribute.dce  
org.keycloak.dom.saml.v2.profiles.sso.ecp  
org.keycloak.dom.saml.v2.protocol
Package containing the classes for the protocol of SAMLv2
org.keycloak.dom.xmlsec.w3.xmldsig  
org.keycloak.dom.xmlsec.w3.xmlenc  
org.keycloak.email  
org.keycloak.email.freemarker  
org.keycloak.email.freemarker.beans  
org.keycloak.encoding  
org.keycloak.enums  
org.keycloak.events  
org.keycloak.events.admin  
org.keycloak.events.email  
org.keycloak.events.jpa  
org.keycloak.events.log  
org.keycloak.exceptions  
org.keycloak.executors  
org.keycloak.exportimport  
org.keycloak.exportimport.dir  
org.keycloak.exportimport.singlefile  
org.keycloak.exportimport.util  
org.keycloak.federation.kerberos  
org.keycloak.federation.kerberos.impl  
org.keycloak.federation.sssd  
org.keycloak.federation.sssd.api  
org.keycloak.federation.sssd.impl  
org.keycloak.forms.account  
org.keycloak.forms.account.freemarker  
org.keycloak.forms.account.freemarker.model  
org.keycloak.forms.login  
org.keycloak.forms.login.freemarker  
org.keycloak.forms.login.freemarker.model  
org.keycloak.headers  
org.keycloak.http  
org.keycloak.jose  
org.keycloak.jose.jwe  
org.keycloak.jose.jwe.alg  
org.keycloak.jose.jwe.enc  
org.keycloak.jose.jwk  
org.keycloak.jose.jws  
org.keycloak.jose.jws.crypto  
org.keycloak.json  
org.keycloak.keys  
org.keycloak.keys.infinispan  
org.keycloak.keys.loader  
org.keycloak.locale  
org.keycloak.migration  
org.keycloak.migration.migrators  
org.keycloak.models  
org.keycloak.models.cache  
org.keycloak.models.cache.authorization  
org.keycloak.models.cache.infinispan  
org.keycloak.models.cache.infinispan.authorization  
org.keycloak.models.cache.infinispan.authorization.entities  
org.keycloak.models.cache.infinispan.authorization.events  
org.keycloak.models.cache.infinispan.authorization.stream  
org.keycloak.models.cache.infinispan.entities  
org.keycloak.models.cache.infinispan.events  
org.keycloak.models.cache.infinispan.stream  
org.keycloak.models.credential  
org.keycloak.models.credential.dto  
org.keycloak.models.dblock  
org.keycloak.models.delegate  
org.keycloak.models.jpa  
org.keycloak.models.jpa.converter  
org.keycloak.models.jpa.entities  
org.keycloak.models.jpa.session  
org.keycloak.models.locking  
org.keycloak.models.map.annotations  
org.keycloak.models.map.authorization  
org.keycloak.models.map.authorization.adapter  
org.keycloak.models.map.authorization.entity  
org.keycloak.models.map.authSession  
org.keycloak.models.map.client  
org.keycloak.models.map.clientscope  
org.keycloak.models.map.common  
org.keycloak.models.map.common.delegate  
org.keycloak.models.map.credential  
org.keycloak.models.map.datastore  
org.keycloak.models.map.deploymentState  
org.keycloak.models.map.events  
org.keycloak.models.map.exceptions  
org.keycloak.models.map.group  
org.keycloak.models.map.keys  
org.keycloak.models.map.lock  
org.keycloak.models.map.loginFailure  
org.keycloak.models.map.processor  
org.keycloak.models.map.realm  
org.keycloak.models.map.realm.entity  
org.keycloak.models.map.role  
org.keycloak.models.map.singleUseObject  
org.keycloak.models.map.storage  
org.keycloak.models.map.storage.chm  
org.keycloak.models.map.storage.criteria  
org.keycloak.models.map.storage.file  
org.keycloak.models.map.storage.file.common  
org.keycloak.models.map.storage.file.yaml  
org.keycloak.models.map.storage.hotRod  
org.keycloak.models.map.storage.hotRod.authorization  
org.keycloak.models.map.storage.hotRod.authSession  
org.keycloak.models.map.storage.hotRod.client  
org.keycloak.models.map.storage.hotRod.clientscope  
org.keycloak.models.map.storage.hotRod.common  
org.keycloak.models.map.storage.hotRod.connections  
org.keycloak.models.map.storage.hotRod.events  
org.keycloak.models.map.storage.hotRod.group  
org.keycloak.models.map.storage.hotRod.locking  
org.keycloak.models.map.storage.hotRod.loginFailure  
org.keycloak.models.map.storage.hotRod.realm  
org.keycloak.models.map.storage.hotRod.realm.entity  
org.keycloak.models.map.storage.hotRod.role  
org.keycloak.models.map.storage.hotRod.singleUseObject  
org.keycloak.models.map.storage.hotRod.transaction  
org.keycloak.models.map.storage.hotRod.user  
org.keycloak.models.map.storage.hotRod.userSession  
org.keycloak.models.map.storage.jpa  
org.keycloak.models.map.storage.jpa.authorization.permission  
org.keycloak.models.map.storage.jpa.authorization.permission.delegate  
org.keycloak.models.map.storage.jpa.authorization.permission.entity  
org.keycloak.models.map.storage.jpa.authorization.policy  
org.keycloak.models.map.storage.jpa.authorization.policy.delegate  
org.keycloak.models.map.storage.jpa.authorization.policy.entity  
org.keycloak.models.map.storage.jpa.authorization.resource  
org.keycloak.models.map.storage.jpa.authorization.resource.delegate  
org.keycloak.models.map.storage.jpa.authorization.resource.entity  
org.keycloak.models.map.storage.jpa.authorization.resourceServer  
org.keycloak.models.map.storage.jpa.authorization.resourceServer.delegate  
org.keycloak.models.map.storage.jpa.authorization.resourceServer.entity  
org.keycloak.models.map.storage.jpa.authorization.scope  
org.keycloak.models.map.storage.jpa.authorization.scope.delagate  
org.keycloak.models.map.storage.jpa.authorization.scope.entity  
org.keycloak.models.map.storage.jpa.authSession  
org.keycloak.models.map.storage.jpa.authSession.delegate  
org.keycloak.models.map.storage.jpa.authSession.entity  
org.keycloak.models.map.storage.jpa.client  
org.keycloak.models.map.storage.jpa.client.delegate  
org.keycloak.models.map.storage.jpa.client.entity  
org.keycloak.models.map.storage.jpa.clientScope  
org.keycloak.models.map.storage.jpa.clientScope.delegate  
org.keycloak.models.map.storage.jpa.clientScope.entity  
org.keycloak.models.map.storage.jpa.event.admin  
org.keycloak.models.map.storage.jpa.event.admin.entity  
org.keycloak.models.map.storage.jpa.event.auth  
org.keycloak.models.map.storage.jpa.event.auth.entity  
org.keycloak.models.map.storage.jpa.group  
org.keycloak.models.map.storage.jpa.group.delegate  
org.keycloak.models.map.storage.jpa.group.entity  
org.keycloak.models.map.storage.jpa.hibernate  
org.keycloak.models.map.storage.jpa.hibernate.dialect  
org.keycloak.models.map.storage.jpa.hibernate.jsonb  
org.keycloak.models.map.storage.jpa.hibernate.jsonb.migration  
org.keycloak.models.map.storage.jpa.hibernate.listeners  
org.keycloak.models.map.storage.jpa.liquibase.connection  
org.keycloak.models.map.storage.jpa.liquibase.extension  
org.keycloak.models.map.storage.jpa.liquibase.lockservice  
org.keycloak.models.map.storage.jpa.liquibase.updater  
org.keycloak.models.map.storage.jpa.lock  
org.keycloak.models.map.storage.jpa.lock.delegate  
org.keycloak.models.map.storage.jpa.lock.entity  
org.keycloak.models.map.storage.jpa.loginFailure  
org.keycloak.models.map.storage.jpa.loginFailure.delegate  
org.keycloak.models.map.storage.jpa.loginFailure.entity  
org.keycloak.models.map.storage.jpa.realm  
org.keycloak.models.map.storage.jpa.realm.delegate  
org.keycloak.models.map.storage.jpa.realm.entity  
org.keycloak.models.map.storage.jpa.role  
org.keycloak.models.map.storage.jpa.role.delegate  
org.keycloak.models.map.storage.jpa.role.entity  
org.keycloak.models.map.storage.jpa.singleUseObject  
org.keycloak.models.map.storage.jpa.singleUseObject.entity  
org.keycloak.models.map.storage.jpa.updater  
org.keycloak.models.map.storage.jpa.user  
org.keycloak.models.map.storage.jpa.user.delegate  
org.keycloak.models.map.storage.jpa.user.entity  
org.keycloak.models.map.storage.jpa.userSession  
org.keycloak.models.map.storage.jpa.userSession.entity  
org.keycloak.models.map.storage.ldap  
org.keycloak.models.map.storage.ldap.config  
org.keycloak.models.map.storage.ldap.model  
org.keycloak.models.map.storage.ldap.role  
org.keycloak.models.map.storage.ldap.role.config  
org.keycloak.models.map.storage.ldap.role.entity  
org.keycloak.models.map.storage.ldap.store  
org.keycloak.models.map.storage.tree  
org.keycloak.models.map.user  
org.keycloak.models.map.userSession  
org.keycloak.models.session  
org.keycloak.models.sessions.infinispan  
org.keycloak.models.sessions.infinispan.changes  
org.keycloak.models.sessions.infinispan.changes.sessions  
org.keycloak.models.sessions.infinispan.entities  
org.keycloak.models.sessions.infinispan.entities.wildfly  
org.keycloak.models.sessions.infinispan.events  
org.keycloak.models.sessions.infinispan.initializer  
org.keycloak.models.sessions.infinispan.remotestore  
org.keycloak.models.sessions.infinispan.stream  
org.keycloak.models.sessions.infinispan.util  
org.keycloak.models.utils  
org.keycloak.models.utils.reflection  
org.keycloak.partialimport  
org.keycloak.platform  
org.keycloak.policy  
org.keycloak.protocol  
org.keycloak.protocol.docker  
org.keycloak.protocol.docker.installation  
org.keycloak.protocol.docker.installation.compose  
org.keycloak.protocol.docker.mapper  
org.keycloak.protocol.oidc  
org.keycloak.protocol.oidc.client.authentication  
org.keycloak.protocol.oidc.endpoints  
org.keycloak.protocol.oidc.endpoints.request  
org.keycloak.protocol.oidc.ext  
org.keycloak.protocol.oidc.grants.ciba  
org.keycloak.protocol.oidc.grants.ciba.channel  
org.keycloak.protocol.oidc.grants.ciba.clientpolicy.context  
org.keycloak.protocol.oidc.grants.ciba.clientpolicy.executor  
org.keycloak.protocol.oidc.grants.ciba.endpoints  
org.keycloak.protocol.oidc.grants.ciba.endpoints.request  
org.keycloak.protocol.oidc.grants.ciba.resolvers  
org.keycloak.protocol.oidc.grants.device  
org.keycloak.protocol.oidc.grants.device.clientpolicy.context  
org.keycloak.protocol.oidc.grants.device.endpoints  
org.keycloak.protocol.oidc.installation  
org.keycloak.protocol.oidc.mappers  
org.keycloak.protocol.oidc.par  
org.keycloak.protocol.oidc.par.clientpolicy.context  
org.keycloak.protocol.oidc.par.endpoints  
org.keycloak.protocol.oidc.par.endpoints.request  
org.keycloak.protocol.oidc.rar  
org.keycloak.protocol.oidc.rar.model  
org.keycloak.protocol.oidc.rar.parsers  
org.keycloak.protocol.oidc.representations  
org.keycloak.protocol.oidc.utils  
org.keycloak.protocol.openshift  
org.keycloak.protocol.saml  
org.keycloak.protocol.saml.clientregistration  
org.keycloak.protocol.saml.installation  
org.keycloak.protocol.saml.mappers  
org.keycloak.protocol.saml.preprocessor  
org.keycloak.protocol.saml.profile.ecp  
org.keycloak.protocol.saml.profile.ecp.authenticator  
org.keycloak.protocol.saml.profile.util  
org.keycloak.protocol.saml.util  
org.keycloak.protocol.util  
org.keycloak.provider  
org.keycloak.rar  
org.keycloak.representations  
org.keycloak.representations.account  
org.keycloak.representations.adapters.action  
org.keycloak.representations.adapters.config  
org.keycloak.representations.docker  
org.keycloak.representations.idm  
org.keycloak.representations.idm.authorization  
org.keycloak.representations.info  
org.keycloak.representations.oidc  
org.keycloak.representations.provider  
org.keycloak.rotation  
org.keycloak.saml  
org.keycloak.saml.common  
org.keycloak.saml.common.constants  
org.keycloak.saml.common.exceptions  
org.keycloak.saml.common.exceptions.fed  
org.keycloak.saml.common.parsers  
org.keycloak.saml.common.util  
org.keycloak.saml.processing.api.saml.v2.request  
org.keycloak.saml.processing.api.saml.v2.response  
org.keycloak.saml.processing.api.saml.v2.sig  
org.keycloak.saml.processing.api.util  
org.keycloak.saml.processing.core.constants  
org.keycloak.saml.processing.core.parsers.saml  
org.keycloak.saml.processing.core.parsers.saml.assertion  
org.keycloak.saml.processing.core.parsers.saml.mdattr  
org.keycloak.saml.processing.core.parsers.saml.mdui  
org.keycloak.saml.processing.core.parsers.saml.metadata  
org.keycloak.saml.processing.core.parsers.saml.protocol  
org.keycloak.saml.processing.core.parsers.saml.xmldsig  
org.keycloak.saml.processing.core.parsers.util  
org.keycloak.saml.processing.core.saml.v1  
org.keycloak.saml.processing.core.saml.v1.writers  
org.keycloak.saml.processing.core.saml.v2.common  
org.keycloak.saml.processing.core.saml.v2.constants  
org.keycloak.saml.processing.core.saml.v2.factories  
org.keycloak.saml.processing.core.saml.v2.holders  
org.keycloak.saml.processing.core.saml.v2.util  
org.keycloak.saml.processing.core.saml.v2.writers  
org.keycloak.saml.processing.core.util  
org.keycloak.saml.processing.web.util  
org.keycloak.saml.validators  
org.keycloak.scripting  
org.keycloak.services  
org.keycloak.services.clientpolicy  
org.keycloak.services.clientpolicy.condition  
org.keycloak.services.clientpolicy.context  
org.keycloak.services.clientpolicy.executor  
org.keycloak.services.clientregistration  
org.keycloak.services.clientregistration.oidc  
org.keycloak.services.clientregistration.policy  
org.keycloak.services.clientregistration.policy.impl  
org.keycloak.services.error  
org.keycloak.services.filters  
org.keycloak.services.legacysessionsupport  
org.keycloak.services.managers  
org.keycloak.services.messages  
org.keycloak.services.migration  
org.keycloak.services.resource  
org.keycloak.services.resources  
org.keycloak.services.resources.account  
org.keycloak.services.resources.account.resources  
org.keycloak.services.resources.admin  
org.keycloak.services.resources.admin.ext  
org.keycloak.services.resources.admin.info  
org.keycloak.services.resources.admin.permissions  
org.keycloak.services.scheduled  
org.keycloak.services.util  
org.keycloak.services.validation  
org.keycloak.services.x509  
org.keycloak.sessions  
org.keycloak.social.bitbucket  
org.keycloak.social.facebook  
org.keycloak.social.github  
org.keycloak.social.gitlab  
org.keycloak.social.google  
org.keycloak.social.instagram  
org.keycloak.social.linkedin  
org.keycloak.social.microsoft  
org.keycloak.social.openshift  
org.keycloak.social.paypal  
org.keycloak.social.stackoverflow  
org.keycloak.social.twitter  
org.keycloak.storage  
org.keycloak.storage.adapter  
org.keycloak.storage.client  
org.keycloak.storage.clientscope  
org.keycloak.storage.datastore  
org.keycloak.storage.federated  
org.keycloak.storage.group  
org.keycloak.storage.jpa  
org.keycloak.storage.jpa.entity  
org.keycloak.storage.ldap  
org.keycloak.storage.ldap.idm.model  
org.keycloak.storage.ldap.idm.query  
org.keycloak.storage.ldap.idm.query.internal  
org.keycloak.storage.ldap.idm.store  
org.keycloak.storage.ldap.idm.store.ldap  
org.keycloak.storage.ldap.idm.store.ldap.extended  
org.keycloak.storage.ldap.kerberos  
org.keycloak.storage.ldap.mappers  
org.keycloak.storage.ldap.mappers.membership  
org.keycloak.storage.ldap.mappers.membership.group  
org.keycloak.storage.ldap.mappers.membership.role  
org.keycloak.storage.ldap.mappers.msad  
org.keycloak.storage.ldap.mappers.msadlds  
org.keycloak.storage.managers  
org.keycloak.storage.openshift  
org.keycloak.storage.role  
org.keycloak.storage.user  
org.keycloak.theme  
org.keycloak.theme.beans  
org.keycloak.theme.freemarker  
org.keycloak.timer  
org.keycloak.timer.basic  
org.keycloak.transaction  
org.keycloak.truststore  
org.keycloak.url  
org.keycloak.urls  
org.keycloak.userprofile  
org.keycloak.userprofile.config  
org.keycloak.userprofile.validator  
org.keycloak.util  
org.keycloak.utils  
org.keycloak.validate  
org.keycloak.validate.validators  
org.keycloak.validation  
org.keycloak.vault  
org.keycloak.wellknown