OIDCLoginProtocolFactory (Keycloak Docs Distribution 10.0.2 API)

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`	`GROUPS`
`static String`	`LOCALE`
`static String`	`MICROPROFILE_JWT_SCOPE`
`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`	`UPN`
`static String`	`USERNAME`
`static String`	`WEB_ORIGINS_SCOPE`
`static String`	`WEBSITE`
`static String`	`ZONEINFO`

Constructor Summary

Constructors
Constructor and Description

OIDCLoginProtocolFactory()

Constructors
Constructor and Description
`OIDCLoginProtocolFactory()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addDefaults(ClientModel client)`
`static ClientScopeModel`	`addMicroprofileJWTClientScope(RealmModel newRealm)` Adds the `microprofile-jwt` optional client scope to the specified realm.
`static ClientScopeModel`	`addRolesClientScope(RealmModel newRealm)`
`static ClientScopeModel`	`addWebOriginsClientScope(RealmModel newRealm)`
`LoginProtocol`	`create(KeycloakSession session)`
`protected void`	`createDefaultClientScopesImpl(RealmModel newRealm)` Impl should create default client scopes.
`Object`	`createProtocolEndpoint(RealmModel realm, EventBuilder event)`
`Map<String,ProtocolMapperModel>`	`getBuiltinMappers()` List of built in protocol mappers that can be used to apply to clients.
`String`	`getId()`
`void`	`setupClientDefaults(ClientRepresentation rep, ClientModel newClient)` Setup default values for new clients.

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
  - 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
  - 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()
```
    Description copied from interface: LoginProtocolFactory
    
    List of built in protocol mappers that can be used to apply to clients.
    
    Returns:
  - createDefaultClientScopesImpl
```
protected void createDefaultClientScopesImpl(RealmModel newRealm)
```
    Description copied from class: AbstractLoginProtocolFactory
    
    Impl should create default client scopes. This is called usually when new realm is created
    
    Specified by:
    
    createDefaultClientScopesImpl in class AbstractLoginProtocolFactory
  - addRolesClientScope
```
public static ClientScopeModel addRolesClientScope(RealmModel newRealm)
```
  - addWebOriginsClientScope
```
public static ClientScopeModel addWebOriginsClientScope(RealmModel newRealm)
```
  - addMicroprofileJWTClientScope
```
public static ClientScopeModel addMicroprofileJWTClientScope(RealmModel newRealm)
```
    Adds the microprofile-jwt optional client scope to the specified realm. If a microprofile-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 the microprofile-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.
  - 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)
```
    Description copied from interface: LoginProtocolFactory
    
    Setup default values for new clients. This expects that the representation has already set up the client

Class OIDCLoginProtocolFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.keycloak.protocol.AbstractLoginProtocolFactory

Methods inherited from class java.lang.Object

Methods inherited from interface org.keycloak.provider.ProviderFactory

Field Detail

USERNAME

EMAIL

EMAIL_VERIFIED

GIVEN_NAME

FAMILY_NAME

MIDDLE_NAME

NICKNAME

PROFILE_CLAIM

PICTURE

WEBSITE

GENDER

BIRTHDATE

ZONEINFO

UPDATED_AT

FULL_NAME

LOCALE

ADDRESS

PHONE_NUMBER

PHONE_NUMBER_VERIFIED

REALM_ROLES

CLIENT_ROLES

AUDIENCE_RESOLVE

ALLOWED_WEB_ORIGINS

UPN

GROUPS

ROLES_SCOPE

WEB_ORIGINS_SCOPE

MICROPROFILE_JWT_SCOPE

PROFILE_SCOPE_CONSENT_TEXT

EMAIL_SCOPE_CONSENT_TEXT

ADDRESS_SCOPE_CONSENT_TEXT

PHONE_SCOPE_CONSENT_TEXT

OFFLINE_ACCESS_SCOPE_CONSENT_TEXT

ROLES_SCOPE_CONSENT_TEXT

Constructor Detail

OIDCLoginProtocolFactory

Method Detail

create

getBuiltinMappers

createDefaultClientScopesImpl

addRolesClientScope

addWebOriginsClientScope

addMicroprofileJWTClientScope

addDefaults

createProtocolEndpoint

getId

setupClientDefaults