Package org.keycloak.protocol.oidc
Class OIDCLoginProtocolFactory
java.lang.Object
org.keycloak.protocol.AbstractLoginProtocolFactory
org.keycloak.protocol.oidc.OIDCLoginProtocolFactory
- All Implemented Interfaces:
org.keycloak.protocol.LoginProtocolFactory,org.keycloak.provider.ProviderFactory<org.keycloak.protocol.LoginProtocol>
public class OIDCLoginProtocolFactory
extends org.keycloak.protocol.AbstractLoginProtocolFactory
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringDeprecated.To be removed in Keycloak 27static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final intdetermines the order in which the login protocols are displayed in the dropdown boxes in the UIstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.keycloak.models.ClientScopeModeladdAcrClientScope(org.keycloak.models.RealmModel newRealm) org.keycloak.models.ClientScopeModeladdBasicClientScope(org.keycloak.models.RealmModel newRealm) protected voidaddDefaults(org.keycloak.models.ClientModel client) org.keycloak.models.ClientScopeModeladdMicroprofileJWTClientScope(org.keycloak.models.RealmModel newRealm) Adds themicroprofile-jwtoptional client scope to the specified realm.org.keycloak.models.ClientScopeModeladdRolesClientScope(org.keycloak.models.RealmModel newRealm) org.keycloak.models.ClientScopeModeladdServiceAccountClientScope(org.keycloak.models.RealmModel newRealm) org.keycloak.models.ClientScopeModeladdWebOriginsClientScope(org.keycloak.models.RealmModel newRealm) org.keycloak.protocol.LoginProtocolcreate(org.keycloak.models.KeycloakSession session) protected voidcreateDefaultClientScopesImpl(org.keycloak.models.RealmModel newRealm) createProtocolEndpoint(org.keycloak.models.KeycloakSession session, org.keycloak.events.EventBuilder event) List<org.keycloak.provider.ProviderConfigProperty>getId()voidinit(org.keycloak.Config.Scope config) intorder()defines the option-order in the admin-uivoidsetupClientDefaults(org.keycloak.representations.idm.ClientRepresentation rep, org.keycloak.models.ClientModel newClient) Methods inherited from class org.keycloak.protocol.AbstractLoginProtocolFactory
addClientScopeDefaults, addDefaultClientScopes, addDefaultClientScopes, close, createDefaultClientScopes, postInitMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.keycloak.protocol.LoginProtocolFactory
allowAsClientProtocol, isValidClientScope, onConsentRevoked, validateClientScope, validateClientScopeAssignmentMethods inherited from interface org.keycloak.provider.ProviderFactory
dependsOn
-
Field Details
-
UI_ORDER
public static final int UI_ORDERdetermines the order in which the login protocols are displayed in the dropdown boxes in the UI- See Also:
-
USERNAME
- See Also:
-
EMAIL
- See Also:
-
EMAIL_VERIFIED
- See Also:
-
GIVEN_NAME
- See Also:
-
FAMILY_NAME
- See Also:
-
MIDDLE_NAME
- See Also:
-
NICKNAME
- See Also:
-
PROFILE_CLAIM
- See Also:
-
PICTURE
- See Also:
-
WEBSITE
- See Also:
-
GENDER
- See Also:
-
BIRTHDATE
- See Also:
-
ZONEINFO
- See Also:
-
UPDATED_AT
- See Also:
-
FULL_NAME
- See Also:
-
LOCALE
- See Also:
-
ADDRESS
- See Also:
-
PHONE_NUMBER
- See Also:
-
PHONE_NUMBER_VERIFIED
- See Also:
-
REALM_ROLES
- See Also:
-
CLIENT_ROLES
- See Also:
-
AUDIENCE_RESOLVE
- See Also:
-
ALLOWED_WEB_ORIGINS
- See Also:
-
ACR
- See Also:
-
DELEGATION_MAY_ACT_SUB
- See Also:
-
ORGANIZATION
- See Also:
-
UPN
- See Also:
-
GROUPS
- See Also:
-
ROLES_SCOPE
- See Also:
-
WEB_ORIGINS_SCOPE
- See Also:
-
MICROPROFILE_JWT_SCOPE
- See Also:
-
ACR_SCOPE
- See Also:
-
BASIC_SCOPE
- See Also:
-
DELEGATION_SCOPE
- See Also:
-
PROFILE_SCOPE_CONSENT_TEXT
- See Also:
-
EMAIL_SCOPE_CONSENT_TEXT
- See Also:
-
ADDRESS_SCOPE_CONSENT_TEXT
- See Also:
-
PHONE_SCOPE_CONSENT_TEXT
- See Also:
-
OFFLINE_ACCESS_SCOPE_CONSENT_TEXT
- See Also:
-
ROLES_SCOPE_CONSENT_TEXT
- See Also:
-
ORGANIZATION_SCOPE_CONSENT_TEXT
- See Also:
-
CONFIG_OIDC_REQ_PARAMS_DEFAULT_MAX_SIZE
- See Also:
-
CONFIG_OIDC_REQ_TOKEN_PARAMS_DEFAULT_MAX_SIZE
- See Also:
-
CONFIG_OIDC_REQ_PARAMS_MAX_SIZE_PREFIX
- See Also:
-
CONFIG_OIDC_ADD_REQ_PARAMS_MAX_NUMBER
- See Also:
-
CONFIG_OIDC_ADD_REQ_PARAMS_MAX_SIZE
- See Also:
-
CONFIG_OIDC_ADD_REQ_PARAMS_MAX_OVERALL_SIZE
- See Also:
-
CONFIG_OIDC_ADD_REQ_PARAMS_FAIL_FAST
- See Also:
-
CONFIG_OIDC_ADD_REQ_TOKEN_PARAMS_FAIL_FAST
- See Also:
-
CONFIG_OIDC_ALLOW_MULTIPLE_AUDIENCES_FOR_JWT_CLIENT_AUTHENTICATION
Deprecated.To be removed in Keycloak 27- See Also:
-
CONFIG_ALLOW_TOKEN_INTROSPECTION_WITHOUT_AUDIENCE_CHECK
- See Also:
-
CONFIG_ALLOW_USERINFO_WITH_LIGHTWEIGHT_ACCESS_TOKEN
- See Also:
-
-
Constructor Details
-
OIDCLoginProtocolFactory
public OIDCLoginProtocolFactory()
-
-
Method Details
-
init
public void init(org.keycloak.Config.Scope config) - Specified by:
initin interfaceorg.keycloak.provider.ProviderFactory<org.keycloak.protocol.LoginProtocol>- Overrides:
initin classorg.keycloak.protocol.AbstractLoginProtocolFactory
-
create
public org.keycloak.protocol.LoginProtocol create(org.keycloak.models.KeycloakSession session) -
getBuiltinMappers
-
createDefaultClientScopesImpl
protected void createDefaultClientScopesImpl(org.keycloak.models.RealmModel newRealm) - Specified by:
createDefaultClientScopesImplin classorg.keycloak.protocol.AbstractLoginProtocolFactory
-
addRolesClientScope
public org.keycloak.models.ClientScopeModel addRolesClientScope(org.keycloak.models.RealmModel newRealm) -
addWebOriginsClientScope
public org.keycloak.models.ClientScopeModel addWebOriginsClientScope(org.keycloak.models.RealmModel newRealm) -
addMicroprofileJWTClientScope
public org.keycloak.models.ClientScopeModel addMicroprofileJWTClientScope(org.keycloak.models.RealmModel newRealm) Adds themicroprofile-jwtoptional client scope to the specified realm. If amicroprofile-jwtclient scope already exists in the realm then the existing scope is returned. Otherwise, a new scope is created and returned.- Parameters:
newRealm- the realm to which themicroprofile-jwtscope is to be added.- Returns:
- a reference to the
microprofile-jwtclient scope that was either created or already exists in the realm.
-
addAcrClientScope
public org.keycloak.models.ClientScopeModel addAcrClientScope(org.keycloak.models.RealmModel newRealm) -
addBasicClientScope
public org.keycloak.models.ClientScopeModel addBasicClientScope(org.keycloak.models.RealmModel newRealm) -
addServiceAccountClientScope
public org.keycloak.models.ClientScopeModel addServiceAccountClientScope(org.keycloak.models.RealmModel newRealm) -
addDefaults
protected void addDefaults(org.keycloak.models.ClientModel client) - Specified by:
addDefaultsin classorg.keycloak.protocol.AbstractLoginProtocolFactory
-
createProtocolEndpoint
public Object createProtocolEndpoint(org.keycloak.models.KeycloakSession session, org.keycloak.events.EventBuilder event) -
getId
-
setupClientDefaults
public void setupClientDefaults(org.keycloak.representations.idm.ClientRepresentation rep, org.keycloak.models.ClientModel newClient) -
order
public int order()defines the option-order in the admin-ui -
getConfigMetadata
-