NZTA\OktaAPI\Jobs\SyncOktaGroupsJob
Synopsis
class SyncOktaGroupsJob
extends AbstractOktaSyncJob
implements
QueuedJob
{
- // members
- public OktaService $OktaService;
- private static array $dependencies = ;
- private static integer $reschedule_time = 86400;
- // Inherited members from AbstractOktaSyncJob
- protected static array $additional_job_list;
- protected static integer $deleted_warning_threshold;
- protected static integer $bulk_insert_pagination_limit;
- protected static integer $bulk_update_pagination_limit;
- // methods
- public string getTitle()
- public void process()
- private void syncOktaGroups()
- private boolean saveGroup()
- private boolean checkMatchesFilter()
- private void removeDeletedGroups()
- // Inherited methods from AbstractOktaSyncJob
- protected void scheduleNextExecution()
- protected void scheduleAdditionalJobs()
- protected void markJobAsDone()
- public LoggerInterface getLogger()
Hierarchy
Members
private
- $dependencies — array
- $reschedule_time
—
integer
Time in seconds to reschedule for, from when this job finishes.
protected
- $additional_job_list — array
- $bulk_insert_pagination_limit
—
integer
The limit of sql insert queries per insert in @insertUsers method - $bulk_update_pagination_limit
—
integer
The limit of sql update queries per update in @updateUsers method - $deleted_warning_threshold
—
integer
The limit of users to delete before the job will log an INFO level message
public
- $OktaService — NZTA\OktaAPI\Services\OktaService
Methods
private
- checkMatchesFilter() — Check if the specified group matches against one of the filters. We assume the filter keys can only be nested two levels down using the dot (e.g. "key.subkey") syntax.
- removeDeletedGroups() — Compare the list of current groups from the Okta API and remove any SS created groups that are Okta flagged groups if they no longer exist.
- saveGroup() — Save the group into the CMS unless there are filters. If there are filters, check the group matches against one of the filters first.
- syncOktaGroups() — Retrieve all the groups from Okta and save all the groups that match the filters created in the CMS. If no filters are added to the CMS, save all the groups.
public
- getTitle()
- process() — Use the {@link OktaService} to get the full list of groups from the Okta API.
Inherited from NZTA\OktaAPI\Jobs\AbstractOktaSyncJob
protected
- markJobAsDone() — Complete the job so it can removed from the queue
- scheduleAdditionalJobs() — Schedule additional jobs
- scheduleNextExecution() — Queue up the next job to run.
public
- getLogger() — Get a logger