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
-
Constructor Summary
Constructors Constructor Description OIDCLoginProtocolFactory()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
addAcrClientScope(org.keycloak.models.RealmModel newRealm)
protected void
addDefaults(org.keycloak.models.ClientModel client)
static org.keycloak.models.ClientScopeModel
addMicroprofileJWTClientScope(org.keycloak.models.RealmModel newRealm)
Adds themicroprofile-jwt
optional client scope to the specified realm.static org.keycloak.models.ClientScopeModel
addRolesClientScope(org.keycloak.models.RealmModel newRealm)
static org.keycloak.models.ClientScopeModel
addWebOriginsClientScope(org.keycloak.models.RealmModel newRealm)
org.keycloak.protocol.LoginProtocol
create(org.keycloak.models.KeycloakSession session)
protected void
createDefaultClientScopesImpl(org.keycloak.models.RealmModel newRealm)
Object
createProtocolEndpoint(org.keycloak.models.RealmModel realm, org.keycloak.events.EventBuilder event)
Map<String,org.keycloak.models.ProtocolMapperModel>
getBuiltinMappers()
String
getId()
void
init(org.keycloak.Config.Scope config)
void
setupClientDefaults(org.keycloak.representations.idm.ClientRepresentation rep, org.keycloak.models.ClientModel newClient)
-
Methods inherited from class org.keycloak.protocol.AbstractLoginProtocolFactory
addDefaultClientScopes, addDefaultClientScopes, close, createDefaultClientScopes, postInit
-
-
-
-
Field Detail
-
USERNAME
public static final String USERNAME
- See Also:
- Constant Field Values
-
EMAIL
public static final String EMAIL
- See Also:
- Constant Field Values
-
EMAIL_VERIFIED
public static final String EMAIL_VERIFIED
- See Also:
- Constant Field Values
-
GIVEN_NAME
public static final String GIVEN_NAME
- See Also:
- Constant Field Values
-
FAMILY_NAME
public static final String FAMILY_NAME
- See Also:
- Constant Field Values
-
MIDDLE_NAME
public static final String MIDDLE_NAME
- See Also:
- Constant Field Values
-
NICKNAME
public static final String NICKNAME
- See Also:
- Constant Field Values
-
PROFILE_CLAIM
public static final String PROFILE_CLAIM
- See Also:
- Constant Field Values
-
PICTURE
public static final String PICTURE
- See Also:
- Constant Field Values
-
WEBSITE
public static final String WEBSITE
- See Also:
- Constant Field Values
-
GENDER
public static final String GENDER
- See Also:
- Constant Field Values
-
BIRTHDATE
public static final String BIRTHDATE
- See Also:
- Constant Field Values
-
ZONEINFO
public static final String ZONEINFO
- See Also:
- Constant Field Values
-
UPDATED_AT
public static final String UPDATED_AT
- See Also:
- Constant Field Values
-
FULL_NAME
public static final String FULL_NAME
- See Also:
- Constant Field Values
-
LOCALE
public static final String LOCALE
- See Also:
- Constant Field Values
-
ADDRESS
public static final String ADDRESS
- See Also:
- Constant Field Values
-
PHONE_NUMBER
public static final String PHONE_NUMBER
- See Also:
- Constant Field Values
-
PHONE_NUMBER_VERIFIED
public static final String PHONE_NUMBER_VERIFIED
- See Also:
- Constant Field Values
-
REALM_ROLES
public static final String REALM_ROLES
- See Also:
- Constant Field Values
-
CLIENT_ROLES
public static final String CLIENT_ROLES
- See Also:
- Constant Field Values
-
AUDIENCE_RESOLVE
public static final String AUDIENCE_RESOLVE
- See Also:
- Constant Field Values
-
ALLOWED_WEB_ORIGINS
public static final String ALLOWED_WEB_ORIGINS
- See Also:
- Constant Field Values
-
ACR
public static final String ACR
- See Also:
- Constant Field Values
-
UPN
public static final String UPN
- See Also:
- Constant Field Values
-
GROUPS
public static final String GROUPS
- See Also:
- Constant Field Values
-
ROLES_SCOPE
public static final String ROLES_SCOPE
- See Also:
- Constant Field Values
-
WEB_ORIGINS_SCOPE
public static final String WEB_ORIGINS_SCOPE
- See Also:
- Constant Field Values
-
MICROPROFILE_JWT_SCOPE
public static final String MICROPROFILE_JWT_SCOPE
- See Also:
- Constant Field Values
-
ACR_SCOPE
public static final String ACR_SCOPE
- See Also:
- Constant Field Values
-
PROFILE_SCOPE_CONSENT_TEXT
public static final String PROFILE_SCOPE_CONSENT_TEXT
- See Also:
- Constant Field Values
-
EMAIL_SCOPE_CONSENT_TEXT
public static final String EMAIL_SCOPE_CONSENT_TEXT
- See Also:
- Constant Field Values
-
ADDRESS_SCOPE_CONSENT_TEXT
public static final String ADDRESS_SCOPE_CONSENT_TEXT
- See Also:
- Constant Field Values
-
PHONE_SCOPE_CONSENT_TEXT
public static final String PHONE_SCOPE_CONSENT_TEXT
- See Also:
- Constant Field Values
-
OFFLINE_ACCESS_SCOPE_CONSENT_TEXT
public static final String OFFLINE_ACCESS_SCOPE_CONSENT_TEXT
- See Also:
- Constant Field Values
-
ROLES_SCOPE_CONSENT_TEXT
public static final String ROLES_SCOPE_CONSENT_TEXT
- See Also:
- Constant Field Values
-
CONFIG_LEGACY_LOGOUT_REDIRECT_URI
public static final String CONFIG_LEGACY_LOGOUT_REDIRECT_URI
- See Also:
- Constant Field Values
-
-
Method Detail
-
init
public void init(org.keycloak.Config.Scope config)
- Specified by:
init
in interfaceorg.keycloak.provider.ProviderFactory<org.keycloak.protocol.LoginProtocol>
- Overrides:
init
in classorg.keycloak.protocol.AbstractLoginProtocolFactory
-
create
public org.keycloak.protocol.LoginProtocol create(org.keycloak.models.KeycloakSession session)
-
createDefaultClientScopesImpl
protected void createDefaultClientScopesImpl(org.keycloak.models.RealmModel newRealm)
- Specified by:
createDefaultClientScopesImpl
in classorg.keycloak.protocol.AbstractLoginProtocolFactory
-
addRolesClientScope
public static org.keycloak.models.ClientScopeModel addRolesClientScope(org.keycloak.models.RealmModel newRealm)
-
addWebOriginsClientScope
public static org.keycloak.models.ClientScopeModel addWebOriginsClientScope(org.keycloak.models.RealmModel newRealm)
-
addMicroprofileJWTClientScope
public static org.keycloak.models.ClientScopeModel addMicroprofileJWTClientScope(org.keycloak.models.RealmModel newRealm)
Adds themicroprofile-jwt
optional client scope to the specified realm. If amicroprofile-jwt
client 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-jwt
scope is to be added.- Returns:
- a reference to the
microprofile-jwt
client scope that was either created or already exists in the realm.
-
addAcrClientScope
public static void addAcrClientScope(org.keycloak.models.RealmModel newRealm)
-
addDefaults
protected void addDefaults(org.keycloak.models.ClientModel client)
- Specified by:
addDefaults
in classorg.keycloak.protocol.AbstractLoginProtocolFactory
-
createProtocolEndpoint
public Object createProtocolEndpoint(org.keycloak.models.RealmModel realm, org.keycloak.events.EventBuilder event)
-
getId
public String getId()
-
setupClientDefaults
public void setupClientDefaults(org.keycloak.representations.idm.ClientRepresentation rep, org.keycloak.models.ClientModel newClient)
-
-