Package org.keycloak.social.paypal

Class PayPalIdentityProviderConfig

java.lang.Object

org.keycloak.models.IdentityProviderModel

org.keycloak.broker.oidc.OAuth2IdentityProviderConfig

org.keycloak.social.paypal.PayPalIdentityProviderConfig

All Implemented Interfaces:

Serializable

public class PayPalIdentityProviderConfig
extends OAuth2IdentityProviderConfig

Author:

Petter Lysne (petterlysne at hotmail dot com)

See Also:

• Serialized Form

Field Summary

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, ALLOW_ADMIN_ROLE_MAPPING, 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, FEDERATED_CLIENT_ASSERTION_MAX_EXPIRATION, 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, STORE_TOKEN_IN_SESSION, SYNC_MODE

Constructor Summary

Constructors

Constructor	Description
PayPalIdentityProviderConfig()
PayPalIdentityProviderConfig(IdentityProviderModel model)

Method Summary

Modifier and Type	Method	Description
protected String[]	getClientSecretDestinationConfigKeys()	Config keys that determine where/how a client secret is sent.
protected boolean	isClientSecretDestinationChanged(String key, String stored, String updated)	sandbox is a boolean; an absent value is equivalent to "false", which is what the admin console submits for existing providers created without the key.
void	setSandbox(boolean sandbox)
boolean	targetSandbox()

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

canReuseMaskedClientSecret, 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, validate

Methods inherited from class org.keycloak.models.IdentityProviderModel

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

Methods inherited from class java.lang.Object

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

Constructor Details

PayPalIdentityProviderConfig

public PayPalIdentityProviderConfig(IdentityProviderModel model)

PayPalIdentityProviderConfig

public PayPalIdentityProviderConfig()

Method Details

targetSandbox

public boolean targetSandbox()

setSandbox

public void setSandbox(boolean sandbox)

getClientSecretDestinationConfigKeys

protected String[] getClientSecretDestinationConfigKeys()

Description copied from class: OAuth2IdentityProviderConfig

Config keys that determine where/how a client secret is sent. Includes baseUrl, which some social providers (for example GitHub/OpenShift) use to derive the token endpoint at runtime. Provider-specific configs may override to add keys such as tenantId or sandbox.

Overrides:

getClientSecretDestinationConfigKeys in class OAuth2IdentityProviderConfig

isClientSecretDestinationChanged

protected boolean isClientSecretDestinationChanged(String key,
 String stored,
 String updated)

sandbox is a boolean; an absent value is equivalent to "false", which is what the admin console submits for existing providers created without the key. Parsing mirrors targetSandbox() so the comparison matches the effective token host.

Overrides:

isClientSecretDestinationChanged in class OAuth2IdentityProviderConfig

Parameters:

key - the config key being compared

stored - the currently stored value, possibly null

updated - the submitted value, possibly null

Returns:

true if the values represent different destinations