Skip to main content

Custom scripts (addon admin)

Description

The Custom Scrips page provides the capacity to launch custom scripts to perform any functionality or process that the Soffid API  has available.

Remember that you can consult the Soffid API at the following linkS: Soffid 4 public API and Data & Service model.

Screen overview

image.png

image.png

  • Console log : for more details in case an error has been returned if the script type is "On demand".
  • Syncserver monitoring : for more details in case an error has been returned if the script type is "Shceduled.
  • Scheduled tasks : to manage and execute custom script when the type is "Scheduled".
  • Users :
    • After a user change, the "On user change" is executed.
    • After a grant permission, the "On grant permission" is executed.
    • After a revoke permission, the "On revoke permission" is executed.

Standard attributes

  • Name : name of the custom script.
  • Type : type of the custom sccript.
    • Scheduled : the script is executed in a Sync server and can be scheduled as a task to manage it from the Scheduled tasks page.
    • On demand : the script is executed in the Console.
    • On user change : the script is executed after any user change (except for granting and revoking roles).
    • On grant permission : the script is executed after a grant permission.
    • On revoke permission : the script is executed after a revoke permission.

Actions

AI assistant Ask our AI for help to generate scripts more quickly and efficiently. 
Delete script
Undo
Execute now

Others

Soffid APIs

Below you could find a list of helpful links related to the building of custom scripts.

API for the internal classes of Soffid: https://download.soffid.com/doc/console/latest/uml/

Custom utility classes: https://bookstack.soffid.com/books/soffid-3-reference-guide/page/utility-classes