← Back to plugin index

Delete Users Task
Description
Deletes all users that fulfill a configurable condition.

It is up to the configured user persister to decide whether the deleted users are effectively deleted from the persistent store, or only marked as deleted.

Note that this task iterates over all users and fetches them one-by-one from the persistent store. In order to avoid performance issues, consider configuring the underlying user iterator with a restriction that matches the delete condition, e.g. by using an 'Additional Iterator Where Clause' when using a database user persister.

This task publishes a "User Deleted" event for each deleted user.

Type name
DeleteUsersTask
Class
com.airlock.iam.servicecontainer.app.application.configuration.task.user.DeleteUsersTask
May be used by
Task Schedule
Properties
User Persister (userPersister)
Description
User persister plugin used to read user account data and delete if necessary.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Active Directory Connector Cipher User Persister Combining Extended User Persister Combining User Persister Database User Persister Dummy Extended User Persister LDAP Connector LDAP User Persister Property User Persister
User Iterator (userIterator)
Description
The user iterator plugin used to iterate over all users.

Usually this is the same as the user persister.

Attributes
Plugin-Link
Mandatory
Assignable plugins
Active Directory Connector Cipher User Persister Combining Extended User Persister Combining User Persister Database User Persister Dummy Extended User Persister LDAP Connector LDAP User Persister Property User Persister
Delete Condition (deleteCondition)
Description
The condition that must be true in order to delete a user.
Attributes
Plugin-Link
Mandatory
Assignable plugins
User Locked Predicate User Not Valid Anymore Predicate
YAML Template (with default values) 

type: DeleteUsersTask
id: DeleteUsersTask-xxxxxx
displayName: 
comment: 
properties:
  deleteCondition:
  userIterator:
  userPersister: