Skip to main content

Introduction to Administration addon

Introduction

The administration addon includes two very useful features for Soffid administrators.

On the one hand, we have the ability to generate custom scripts and launch them using different mechanisms.

On the other hand, the export and import of Soffid data is enabled

What is acustom Custom script?scripts?

The Administration Addonaddon providesoffers the capacitypossibility to launchgenerate and execute custom scripts to perform any functionalityfunction or process thatavailable in the Soffid APIAPI.

Soffid 4 has available.introduced AI that allows administrators to generate scripts much more easily, making this process accessible to all types of users.

Additionally,Scripts withcan thisbe addon,run theremanually, isscheduled, availableor the possibilityenabled to enablerun aafter specialcertain touser get the metrics of the performance of the Soffid IAM components.events.

Through the Custom scripts page you could perform the next operations:

  • You could create a new custom script.
  • You could execute the custom scriptThe On demanduse by clicking on the Execute now button.
  • You could execute the custom script as a Scheduled task, and it will be executed as you have configured the timetable.
    • Month: number of the month (1-12) when the task will be performed. 
    • Day:  number of the day (1-31) when the task will be performed.
    • Hour: hour (0-23) when the task will be performed. 
    • Minute: minute (0-59) when the task will be performed.
    • Day of week: number of day (0-7 where 0 means Sunday) of the week when the task will be performed. 
    • Server: where the agent is running.
  • You could define the event in which the script will be launched:

On user change

When you define an event on user change, the user object will be available on the user variable to access and operate with it. 

To find more details about the user object, you can visit the Soffid Objects page.

On grant permission

When you define an event on revoke or grant permission, the grant object will be available on the grant variable to access and operate with it.

To find more details about the grant object, you can visit the Soffid Objects page.

Documentation

Below you could find a list of helpful links related to the building of custom scripts depends on the requirements, the most important thing is that it offers the administrator maximum flexibility to execute whatever is needed.

APILet's look at some examples of custom scripts.

  • List all active accounts on a system with all their roles.
  • Planning to deactivate users upon detecting a period of inactivity.
  • Send an email to administrators when a specific role is granted or revoked.
  • Perform additional actions when a user is deactivated.
  • Apply a mass change to user attributes.
  • Send a weekly email with the users who have roles with segregation of duties.

What is export import?

The Administration addon includes the ability to export most Soffid objects and also import them.

This utility allows you to manually backup part of Soffid or all of its data, and the import function allows you to select some or all of the exported objects

These backups can be useful for different purposes:

 

Back to top