Package org.keycloak.broker.oidc

Class OAuth2IdentityProviderConfig

java.lang.Object

org.keycloak.models.IdentityProviderModel

org.keycloak.broker.oidc.OAuth2IdentityProviderConfig

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OIDCIdentityProviderConfig, OpenshiftV4IdentityProviderConfig, PayPalIdentityProviderConfig, StackOverflowIdentityProviderConfig

public class OAuth2IdentityProviderConfig
extends IdentityProviderModel

Author:

Pedro Igor

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JWT_X509_HEADERS_ENABLED
static final String	PKCE_ENABLED
static final String	PKCE_METHOD
static final String	REQUIRES_SHORT_STATE_PARAMETER
static final String	TOKEN_ENDPOINT_URL
static final String	TOKEN_INTROSPECTION_URL

Fields inherited from class org.keycloak.models.IdentityProviderModel

addReadTokenRoleOnCreate, ALIAS, ALIAS_NOT_IN, ALLOWED_CLOCK_SKEW, AUTHENTICATE_BY_DEFAULT, CASE_SENSITIVE_ORIGINAL_USERNAME, CLAIM_FILTER_NAME, CLAIM_FILTER_VALUE, DEFAULT_MIN_VALIDITY_TOKEN, DISPLAY_NAME, DO_NOT_STORE_USERS, ENABLED, FILTERED_BY_CLAIMS, FIRST_BROKER_LOGIN_FLOW_ID, HIDE_ON_LOGIN, ISSUER, LEGACY_HIDE_ON_LOGIN_ATTR, LINK_ONLY, linkOnly, LOGIN_HINT, METADATA_DESCRIPTOR_URL, MIN_VALIDITY_TOKEN, ORGANIZATION_ID, ORGANIZATION_ID_NOT_NULL, PASS_MAX_AGE, POST_BROKER_LOGIN_FLOW_ID, SEARCH, SHOW_IN_ACCOUNT_CONSOLE, SYNC_MODE

Constructor Summary

Constructors

Constructor	Description
OAuth2IdentityProviderConfig()
OAuth2IdentityProviderConfig(IdentityProviderModel model)

Method Summary

Modifier and Type	Method	Description
String	getAuthorizationUrl()
String	getClientAssertionAudience()
String	getClientAssertionSigningAlg()
String	getClientAuthMethod()
String	getClientId()
String	getClientSecret()
String	getDefaultScope()
String	getEmailClaim()
String	getFamilyNameClaim()
String	getForwardParameters()
String	getFullNameClaim()
String	getGivenNameClaim()
String	getPkceMethod()
String	getPrompt()
String	getTokenIntrospectionUrl()
String	getTokenUrl()
String	getUserIDClaim()
String	getUserInfoUrl()
String	getUserNameClaim()
boolean	isBasicAuthentication()
boolean	isBasicAuthenticationUnencoded()
boolean	isJWTAuthentication()
boolean	isJwtX509HeadersEnabled()
boolean	isPkceEnabled()
boolean	isRequiresShortStateParameter()
boolean	isUiLocales()
void	setAuthorizationUrl(String authorizationUrl)
void	setClientAssertionAudience(String audience)
void	setClientAssertionSigningAlg(String signingAlg)
void	setClientAuthMethod(String clientAuth)
void	setClientId(String clientId)
void	setClientSecret(String clientSecret)
void	setDefaultScope(String defaultScope)
void	setForwardParameters(String forwardParameters)
void	setJwtX509HeadersEnabled(boolean enabled)
void	setPkceEnabled(boolean enabled)
String	setPkceMethod(String method)
void	setRequiresShortStateParameter(boolean requiresShortStateParameter)
void	setTokenIntrospectionUrl(String introspectionEndpointUrl)
void	setTokenUrl(String tokenUrl)
void	setUiLocales(boolean uiLocales)
void	setUserInfoUrl(String userInfoUrl)
void	validate(RealmModel realm)	Validates this configuration.

Methods inherited from class org.keycloak.models.IdentityProviderModel

equals, getAlias, getClaimFilterName, getClaimFilterValue, getConfig, getDisplayIconClasses, getDisplayName, getFirstBrokerLoginFlowId, getInternalId, getMetadataDescriptorUrl, getMinValidityToken, getOrganizationId, getPostBrokerLoginFlowId, getProviderId, getShowInAccountConsole, getSyncMode, hashCode, isAddReadTokenRoleOnCreate, isAuthenticateByDefault, isCaseSensitiveOriginalUsername, isEnabled, isFilteredByClaims, isHideOnLogin, isLinkOnly, isLoginHint, isPassMaxAge, isStoreToken, isTransientUsers, isTrustEmail, setAddReadTokenRoleOnCreate, setAlias, setAuthenticateByDefault, setCaseSensitiveOriginalUsername, setClaimFilterName, setClaimFilterValue, setConfig, setDisplayName, setEnabled, setFilteredByClaims, setFirstBrokerLoginFlowId, setHideOnLogin, setInternalId, setLinkOnly, setLoginHint, setMetadataDescriptorUrl, setMinValidityToken, setOrganizationId, setPassMaxAge, setPostBrokerLoginFlowId, setProviderId, setStoreToken, setSyncMode, setTransientUsers, setTrustEmail

Methods inherited from class java.lang.Object

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

Field Details

PKCE_ENABLED

public static final String PKCE_ENABLED

See Also:

• Constant Field Values

PKCE_METHOD

public static final String PKCE_METHOD

See Also:

• Constant Field Values

TOKEN_ENDPOINT_URL

public static final String TOKEN_ENDPOINT_URL

See Also:

• Constant Field Values

TOKEN_INTROSPECTION_URL

public static final String TOKEN_INTROSPECTION_URL

See Also:

• Constant Field Values

JWT_X509_HEADERS_ENABLED

public static final String JWT_X509_HEADERS_ENABLED

See Also:

• Constant Field Values

REQUIRES_SHORT_STATE_PARAMETER

public static final String REQUIRES_SHORT_STATE_PARAMETER

See Also:

• Constant Field Values

Constructor Details

OAuth2IdentityProviderConfig

public OAuth2IdentityProviderConfig(IdentityProviderModel model)

OAuth2IdentityProviderConfig

public OAuth2IdentityProviderConfig()

Method Details

getAuthorizationUrl

public String getAuthorizationUrl()

setAuthorizationUrl

public void setAuthorizationUrl(String authorizationUrl)

getTokenUrl

public String getTokenUrl()

setTokenUrl

public void setTokenUrl(String tokenUrl)

getUserInfoUrl

public String getUserInfoUrl()

setUserInfoUrl

public void setUserInfoUrl(String userInfoUrl)

getTokenIntrospectionUrl

public String getTokenIntrospectionUrl()

setTokenIntrospectionUrl

public void setTokenIntrospectionUrl(String introspectionEndpointUrl)

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

getClientAuthMethod

public String getClientAuthMethod()

setClientAuthMethod

public void setClientAuthMethod(String clientAuth)

getClientSecret

public String getClientSecret()

setClientSecret

public void setClientSecret(String clientSecret)

getDefaultScope

public String getDefaultScope()

setDefaultScope

public void setDefaultScope(String defaultScope)

isJWTAuthentication

public boolean isJWTAuthentication()

isBasicAuthentication

public boolean isBasicAuthentication()

isBasicAuthenticationUnencoded

public boolean isBasicAuthenticationUnencoded()

isUiLocales

public boolean isUiLocales()

setUiLocales

public void setUiLocales(boolean uiLocales)

getPrompt

public String getPrompt()

isRequiresShortStateParameter

public boolean isRequiresShortStateParameter()

setRequiresShortStateParameter

public void setRequiresShortStateParameter(boolean requiresShortStateParameter)

getForwardParameters

public String getForwardParameters()

setForwardParameters

public void setForwardParameters(String forwardParameters)

isPkceEnabled

public boolean isPkceEnabled()

setPkceEnabled

public void setPkceEnabled(boolean enabled)

getPkceMethod

public String getPkceMethod()

setPkceMethod

public String setPkceMethod(String method)

getClientAssertionSigningAlg

public String getClientAssertionSigningAlg()

setClientAssertionSigningAlg

public void setClientAssertionSigningAlg(String signingAlg)

getClientAssertionAudience

public String getClientAssertionAudience()

setClientAssertionAudience

public void setClientAssertionAudience(String audience)

isJwtX509HeadersEnabled

public boolean isJwtX509HeadersEnabled()

setJwtX509HeadersEnabled

public void setJwtX509HeadersEnabled(boolean enabled)

getUserIDClaim

public String getUserIDClaim()

getUserNameClaim

public String getUserNameClaim()

getFullNameClaim

public String getFullNameClaim()

getGivenNameClaim

public String getGivenNameClaim()

getFamilyNameClaim

public String getFamilyNameClaim()

getEmailClaim

public String getEmailClaim()

validate

public void validate(RealmModel realm)

Description copied from class: IdentityProviderModel

Validates this configuration.

Sub-classes can override this method in order to enforce provider specific validations.

Overrides:

validate in class IdentityProviderModel

Parameters:

realm - the realm