Configuring PingFederate services for Redis storage
You should enable all Redis-capable PingFederate services, but you can manage these services individually if you prefer.
Before you begin
To manage individual Redis-capable services:
-
Configure PingFederate to connect with your Redis cache.
-
Make sure the
pf.redis.modeparameter in the<pingfed_install>/pingfederate/bin/run.propertiesfile is set toOFF.
Learn more in Storing PingFederate data with Redis.
Configuring account locking with Redis
You can configure PingFederate to store Account Locking Service data in a Redis cache.
Steps
-
Open the
<pingfed_install>/pingfederate/server/default/conf/service-points.conffile in a text editor. -
Set the
account.locking.serviceparameter tocom.pingidentity.integrations.redis.lockingservice.AccountLockingServiceRedisImpl. -
Save and close the file.
-
If you’re running PingFederate in a clustered environment, repeat these steps for each node in the cluster.
-
Restart PingFederate.
Configuring artifact storage with Redis
You can configure PingFederate to store authorization artifacts in a Redis cache. Supported artifacts are:
Steps
-
Open the
<pf_install>/pingfederate/server/default/conf/service-points.conffile in a text editor. -
Set the
artifact.storeparameter tocom.pingidentity.integrations.redis.artifactpersistenceservice.ArtifactPersistenceServiceRedisImpl. -
Save and close the file.
-
If you’re running PingFederate in a clustered environment, repeat these steps for each node in the cluster.
-
Restart PingFederate.
Configuring IRSM data storage with Redis
You can configure PingFederate to store Inter-Request State-Management (IRSM) Service data in a Redis cache.
Steps
-
Open the
<pf_install>/pingfederate/server/default/conf/service-points.conffile in a text editor. -
Set the
inter.request.state.mgmtparameter tocom.pingidentity.integrations.redis.irsm.InterRequestStateMgmtRedisImpl. -
Save and close the file.
-
If you’re running PingFederate in a clustered environment, repeat these steps for each node in the cluster.
-
Restart PingFederate.
Configuring Assertion Replay Prevention Service data storage with Redis
You can configure PingFederate to store Assertion Replay Prevention Service data in a Redis cache.
Steps
-
Open the
<pf_install>/pingfederate/server/default/conf/service-points.conffile in a text editor. -
Set the
assertion.replay.prevention.serviceparameter tocom.pingidentity.integrations.redis.assertionreplaypreventionservice.AssertionReplayPreventionServiceRedisImpl. -
Save and close the file.
-
If you’re running PingFederate in a clustered environment, repeat these steps for each node in the cluster.
-
Restart PingFederate.
Configuring dynamic JSON Web Key storage with Redis
You can configure PingFederate to store dynamic JSON Web Keys in a Redis cache. When this service is enabled, PingFederate creates new keys when a new instance or cluster starts. When a cluster restarts, that cluster’s existing keys remain intact.
Steps
-
Open the
<pf_install>/pingfederate/server/default/conf/service-points.conffile in a text editor. -
Set the
dynamic.jwk.storage.serviceparameter tocom.pingidentity.crypto.jwk.DynamicJwkStorageManager -
Save and close the file.
-
If you’re running PingFederate in a clustered environment, repeat these steps for each node in the cluster.
-
Restart PingFederate.
Configuring Session Revocation Service data storage with Redis
You can configure PingFederate to store Back-Channel Session Revocation Service data in a Redis cache.
Steps
-
Open the
<pf_install>/pingfederate/server/default/conf/service-points.conffile in a text editor. -
Set the
session.revocation.serviceparameter tocom.pingidentity.integrations.redis.sessionrevocationservice.SessionRevocationServiceRedisImpl -
Save and close the file.
-
If you’re running PingFederate in a clustered environment, repeat these steps for each node in the cluster.
-
Restart PingFederate.
Configuring OAuth Reference Bearer Access Token plugin data with Redis
You can configure PingFederate to store OAuth Reference Bearer Access Token plugin data in a Redis cache.
Reference bearer tokens provide a reference to a set of stored attributes. Storing reference token data in Redis prevents PingFederate from invalidating the issued tokens and deleting their data on a cluster restart.
Steps
-
Open the
<pf_install>/pingfederate/server/default/conf/service-points.conffile in a text editor. -
Set the
reference.bearer.accesstoken.tracker.factoryparameter tocom.pingidentity.integrations.redis.oauth.ReferenceBearerAccessTokenTrackerFactoryRedisImpl. -
Save and close the file.
-
If you’re running PingFederate in a clustered environment, repeat these steps for each node in the cluster.
-
Restart PingFederate.
Configuring IdP Session Registry Service data with Redis
You can configure PingFederate to store IdP Session Registry Service data in a Redis cache.
Steps
-
Open the
<pf_install>/pingfederate/server/default/conf/service-points.conffile in a text editor. -
Set the
idp.session.registryparameter tocom.pingidentity.integrations.redis.idpsessionregistry.IdpSessionRegistryRedisImpl. -
Save and close the file.
-
If you’re running PingFederate in a clustered environment, repeat these steps for each node in the cluster.
-
Restart PingFederate.
Configuring SP Session Registry Service data with Redis
You can configure PingFederate to store SP Session Registry Service data in a Redis cache.
Steps
-
Open the
<pf_install>/pingfederate/server/default/conf/service-points.conffile in a text editor. -
Set the
sp.session.registryparameter tocom.pingidentity.integrations.redis.spsessionregistry.SpSessionRegistryRedisImpl. -
Save and close the file.
-
If you’re running PingFederate in a clustered environment, repeat these steps for each node in the cluster.
-
Restart PingFederate.