org.keycloak.protocol.oidc

Class OIDCLoginProtocolFactory

java.lang.Object

org.keycloak.protocol.AbstractLoginProtocolFactory

org.keycloak.protocol.oidc.OIDCLoginProtocolFactory

All Implemented Interfaces:

LoginProtocolFactory, ProviderFactory<LoginProtocol>

public class OIDCLoginProtocolFactory
extends AbstractLoginProtocolFactory

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDRESS
static String	ADDRESS_SCOPE_CONSENT_TEXT
static String	ALLOWED_WEB_ORIGINS
static String	AUDIENCE_RESOLVE
static String	BIRTHDATE
static String	CLIENT_ROLES
static String	EMAIL
static String	EMAIL_SCOPE_CONSENT_TEXT
static String	EMAIL_VERIFIED
static String	FAMILY_NAME
static String	FULL_NAME
static String	GENDER
static String	GIVEN_NAME
static String	LOCALE
static String	MIDDLE_NAME
static String	NICKNAME
static String	OFFLINE_ACCESS_SCOPE_CONSENT_TEXT
static String	PHONE_NUMBER
static String	PHONE_NUMBER_VERIFIED
static String	PHONE_SCOPE_CONSENT_TEXT
static String	PICTURE
static String	PROFILE_CLAIM
static String	PROFILE_SCOPE_CONSENT_TEXT
static String	REALM_ROLES
static String	ROLES_SCOPE
static String	ROLES_SCOPE_CONSENT_TEXT
static String	UPDATED_AT
static String	USERNAME
static String	WEB_ORIGINS_SCOPE
static String	WEBSITE
static String	ZONEINFO

Constructor Summary

Constructors

Constructor and Description
OIDCLoginProtocolFactory()

Method Summary

Modifier and Type	Method and Description
protected void	addDefaults(ClientModel client)
static ClientScopeModel	addRolesClientScope(RealmModel newRealm)
static ClientScopeModel	addWebOriginsClientScope(RealmModel newRealm)
LoginProtocol	create(KeycloakSession session)
protected void	createDefaultClientScopesImpl(RealmModel newRealm)
Object	createProtocolEndpoint(RealmModel realm, EventBuilder event)
Map<String,ProtocolMapperModel>	getBuiltinMappers()
String	getId()
void	setupClientDefaults(ClientRepresentation rep, ClientModel newClient)

Methods inherited from class org.keycloak.protocol.AbstractLoginProtocolFactory

addDefaultClientScopes, close, createDefaultClientScopes, init, postInit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.provider.ProviderFactory

order

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

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

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

Constructor Detail

OIDCLoginProtocolFactory

public OIDCLoginProtocolFactory()

Method Detail

create

public LoginProtocol create(KeycloakSession session)

getBuiltinMappers

public Map<String,ProtocolMapperModel> getBuiltinMappers()

createDefaultClientScopesImpl

protected void createDefaultClientScopesImpl(RealmModel newRealm)

Specified by:

createDefaultClientScopesImpl in class AbstractLoginProtocolFactory

addRolesClientScope

public static ClientScopeModel addRolesClientScope(RealmModel newRealm)

addWebOriginsClientScope

public static ClientScopeModel addWebOriginsClientScope(RealmModel newRealm)

addDefaults

protected void addDefaults(ClientModel client)

Specified by:

addDefaults in class AbstractLoginProtocolFactory

createProtocolEndpoint

public Object createProtocolEndpoint(RealmModel realm,
                                     EventBuilder event)

getId

public String getId()

setupClientDefaults

public void setupClientDefaults(ClientRepresentation rep,
                                ClientModel newClient)