How do I create a dynamic schedule directly in an Identity Cloud environment (Staging or Production)?
The purpose of this article is to provide information on creating a dynamic schedule in a specific ForgeRock Identity Cloud environment, that is, creating a schedule directly in the Staging or Production environment as dynamic configuration rather than creating static configuration in the Development environment which is promoted.
Overview
Creating a schedule directly in your Staging or Production environment allows you to have greater control over your schedules on a per environment basis. For example, controlling the intervals, and enabling or disabling different schedules as required. Creating them directly in an environment means they are created as dynamic configuration and won't be included in any subsequent promotions.
You can use the REST API to create dynamic schedules; it is not possible to create dynamic schedules via the UI in Staging and Production environments.
Development environment
- If you create a schedule via the UI in your Development environment, it will get promoted.
- If you want to use REST to create a schedule in your Development environment, you must use the openidm/config/scheduler endpoint (rather than the openidm/scheduler/job endpoint described below) to ensure the schedule is created as static configuration and included in promotions.
Creating a dynamic schedule
You can use the REST API to create and update dynamic schedules in your environments as detailed in Manage schedules Using REST.
Example
You can create a schedule using REST, replacing <tenant-env-fqdn> with your Identity Cloud
tenant name and <access-token> with the access token you obtained when you authenticated to
the Identity Cloud REST API (Authenticate to Identity Cloud REST API with access token):$ curl \
--request PUT 'https://<tenant-env-fqdn>/openidm/scheduler/job/reconciliation-schedule' \
--header 'authorization: Bearer <access-token>' \
--header 'content-type: application/json' \
--header 'Accept-API-Version: resource=2.0' \
--data '{
"enabled": true,
"persisted": true,
"type": "simple",
"repeatInterval": 1800000,
"invokeService": "sync",
"invokeContext": {
"action": "reconcile",
"mapping": "systemLdapAccounts_managedAlpha_user"
}
}'This example creates a schedule (called reconciliation-schedule) that runs a reconciliation for the
systemLdapAccounts_managedAlpha_user mapping every 30 minutes (1800000 milliseconds) and repeats
indefinitely.
See Also
What environments are available in Identity Cloud and what is the promotion process?
How do we determine what is static and dynamic configuration?