Package org.keycloak.social.google

Class GoogleIdentityProviderConfig

java.lang.Object

org.keycloak.models.IdentityProviderModel

org.keycloak.broker.oidc.OAuth2IdentityProviderConfig

org.keycloak.broker.oidc.OIDCIdentityProviderConfig

org.keycloak.social.google.GoogleIdentityProviderConfig

All Implemented Interfaces:

Serializable, JWTAuthorizationGrantConfig

public class GoogleIdentityProviderConfig
extends OIDCIdentityProviderConfig
implements JWTAuthorizationGrantConfig

Author:

Vlastimil Elias (velias at redhat dot com)

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.keycloak.broker.oidc.OIDCIdentityProviderConfig

ALLOW_CLIENT_ID_AS_AUDIENCE, IS_ACCESS_TOKEN_JWT, JWKS_URL, SUPPORTS_CLIENT_ASSERTION_REUSE, SUPPORTS_CLIENT_ASSERTIONS, USE_JWKS_URL, VALIDATE_SIGNATURE

Fields inherited from class org.keycloak.broker.oidc.OAuth2IdentityProviderConfig

JWT_X509_HEADERS_ENABLED, PKCE_ENABLED, PKCE_METHOD, REQUIRES_SHORT_STATE_PARAMETER, TOKEN_ENDPOINT_URL, 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

Fields inherited from interface org.keycloak.broker.jwtauthorizationgrant.JWTAuthorizationGrantConfig

JWT_AUTHORIZATION_GRANT_ALLOWED_CLOCK_SKEW, JWT_AUTHORIZATION_GRANT_ASSERTION_REUSE_ALLOWED, JWT_AUTHORIZATION_GRANT_ASSERTION_SIGNATURE_ALG, JWT_AUTHORIZATION_GRANT_ENABLED, JWT_AUTHORIZATION_GRANT_LIMIT_ACCESS_TOKEN_EXP, JWT_AUTHORIZATION_GRANT_MAX_ALLOWED_ASSERTION_EXPIRATION, PUBLIC_KEY_SIGNATURE_VERIFIER, PUBLIC_KEY_SIGNATURE_VERIFIER_KEY_ID

Constructor Summary

Constructors

Constructor	Description
GoogleIdentityProviderConfig()
GoogleIdentityProviderConfig(IdentityProviderModel model)

Method Summary

Modifier and Type	Method	Description
String	getHostedDomain()
int	getJWTAuthorizationGrantMaxAllowedAssertionExpiration()
boolean	isOfflineAccess()
boolean	isUserIp()
void	setHostedDomain(String hostedDomain)
void	setOfflineAccess(boolean offlineAccess)
void	setUserIp(boolean ip)
void	validate(RealmModel realm)	Validates this configuration.

Methods inherited from class org.keycloak.broker.oidc.OIDCIdentityProviderConfig

getAllowedClockSkew, getLogoutUrl, isAccessTokenJwt, isAllowClientIdAsAudience, isBackchannelSupported, isDisableNonce, isDisableTypeClaimCheck, isDisableUserInfoService, isSendClientIdOnLogout, isSendIdTokenOnLogout, isSupportsClientAssertionReuse, isSupportsClientAssertions, isValidateSignature, setAccessTokenJwt, setAllowClientIdAsAudience, setBackchannelSupported, setDisableNonce, setDisableTypeClaimCheck, setDisableUserInfoService, setLogoutUrl, setPrompt, setSendClientOnLogout, setSendIdTokenOnLogout, setSupportsClientAssertions, setValidateSignature

Methods inherited from class org.keycloak.broker.oidc.OAuth2IdentityProviderConfig

getAuthorizationUrl, getClientAssertionAudience, getClientAssertionSigningAlg, getClientAuthMethod, getClientId, getClientSecret, getDefaultScope, getEmailClaim, getFamilyNameClaim, getForwardParameters, getFullNameClaim, getGivenNameClaim, getPkceMethod, getPrompt, getTokenIntrospectionUrl, getTokenUrl, getUserIDClaim, getUserInfoUrl, getUserNameClaim, isBasicAuthentication, isBasicAuthenticationUnencoded, isJWTAuthentication, isJwtX509HeadersEnabled, isPkceEnabled, isRequiresShortStateParameter, isUiLocales, setAuthorizationUrl, setClientAssertionAudience, setClientAssertionSigningAlg, setClientAuthMethod, setClientId, setClientSecret, setDefaultScope, setForwardParameters, setJwtX509HeadersEnabled, setPkceEnabled, setPkceMethod, setRequiresShortStateParameter, setTokenIntrospectionUrl, setTokenUrl, setUiLocales, setUserInfoUrl

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

Methods inherited from interface org.keycloak.broker.jwtauthorizationgrant.JWTAuthorizationGrantConfig

getAlias, getConfig, getInternalId, getIssuer, getJwksUrl, getJWTAuthorizationGrantAllowedClockSkew, getJWTAuthorizationGrantAssertionSignatureAlg, getPublicKeySignatureVerifier, getPublicKeySignatureVerifierKeyId, isJWTAuthorizationGrantAssertionReuseAllowed, isJWTAuthorizationGrantEnabled, isJwtAuthorizationGrantLimitAccessTokenExp, isUseJwksUrl, setIssuer, setJwksUrl, setJWTAuthorizationGrantEnabled, setPublicKeySignatureVerifier, setPublicKeySignatureVerifierKeyId, setUseJwksUrl

Constructor Details

GoogleIdentityProviderConfig

public GoogleIdentityProviderConfig(IdentityProviderModel model)

GoogleIdentityProviderConfig

public GoogleIdentityProviderConfig()

Method Details

isUserIp

public boolean isUserIp()

setUserIp

public void setUserIp(boolean ip)

getHostedDomain

public String getHostedDomain()

setHostedDomain

public void setHostedDomain(String hostedDomain)

isOfflineAccess

public boolean isOfflineAccess()

setOfflineAccess

public void setOfflineAccess(boolean offlineAccess)

getJWTAuthorizationGrantMaxAllowedAssertionExpiration

public int getJWTAuthorizationGrantMaxAllowedAssertionExpiration()

Specified by:

getJWTAuthorizationGrantMaxAllowedAssertionExpiration in interface JWTAuthorizationGrantConfig

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 OIDCIdentityProviderConfig

Parameters:

realm - the realm