Chat now with support
Chat with Support

Active Roles 8.0 LTS - Administration Guide

Introduction About Active Roles Getting Started Rule-based Administrative Views Role-based Administration
Access Templates as administrative roles Access Template management tasks Examples of use Deployment considerations Windows claims-based Access Rules
Rule-based AutoProvisioning and Deprovisioning
About Policy Objects Policy Object management tasks Policy configuration tasks
Property Generation and Validation User Logon Name Generation Group Membership AutoProvisioning E-mail Alias Generation Exchange Mailbox AutoProvisioning AutoProvisioning for SaaS products OneDrive Provisioning Home Folder AutoProvisioning Script Execution Office 365 and Azure Tenant Selection User Account Deprovisioning Office 365 Licenses Retention Group Membership Removal Exchange Mailbox Deprovisioning Home Folder Deprovisioning User Account Relocation User Account Permanent Deletion Group Object Deprovisioning Group Object Relocation Group Object Permanent Deletion Notification Distribution Report Distribution
Deployment considerations Checking for policy compliance Deprovisioning users or groups Restoring deprovisioned users or groups Container Deletion Prevention policy Picture management rules Policy extensions
Workflows
Understanding workflow Workflow activities overview Configuring a workflow
Creating a workflow definition Configuring workflow start conditions Configuring workflow parameters Adding activities to a workflow Configuring an Approval activity Configuring a Notification activity Configuring a Script activity Configuring an If-Else activity Configuring a Stop/Break activity Configuring an Add Report Section activity Configuring a Search activity Configuring CRUD activities Configuring a Save Object Properties activity Configuring a Modify Requested Changes activity Enabling or disabling an activity Enabling or disabling a workflow Using the initialization script
Example: Approval workflow E-mail based approval Automation workflow Activity extensions
Temporal Group Memberships Group Family Dynamic Groups Active Roles Reporting Management History
Understanding Management History Management History configuration Viewing change history
Workflow activity report sections Policy report items Active Roles internal policy report items
Examining user activity
Entitlement Profile Recycle Bin AD LDS Data Management One Identity Starling Management Managing One Identity Starling Connect Configuring linked mailboxes with Exchange Resource Forest Management Configuring remote mailboxes for on-premises users Azure AD, Office 365, and Exchange Online management
Configuring Active Roles to manage hybrid AD objects Managing Hybrid AD Users Unified provisioning policy for Azure O365 Tenant Selection, Office 365 License Selection, and Office 365 Roles Selection, and OneDrive provisioning Office 365 roles management for hybrid environment users Managing Office 365 Contacts Managing Hybrid AD Groups Managing Microsoft 365 Groups Managing Azure Security Groups Managing cloud-only distribution groups Managing cloud-only Azure users Managing cloud-only Azure guest users Managing cloud-only Azure contacts Changes to Active Roles policies for cloud-only Azure objects Managing room mailboxes Managing cloud-only shared mailboxes
Managing Configuration of Active Roles
Connecting to the Administration Service Adding and removing managed domains Using unmanaged domains Evaluating product usage Creating and using virtual attributes Examining client sessions Monitoring performance Customizing the console Using Configuration Center Changing the Active Roles Admin account Enabling or disabling diagnostic logs Active Roles Log Viewer
SQL Server Replication Appendix A: Using regular expressions Appendix B: Administrative Template Appendix C: Communication ports Appendix D: Active Roles and supported Azure environments Appendix E: Active Roles integration with other One Identity and Quest products Appendix F: Active Roles integration with Duo Appendix G: Active Roles integration with Okta Active Roles Language Pack

Editing a script

Editing a script

To edit a script, select it in the console tree under Configuration/Script Modules. You can view and modify the script in the details pane. To start editing the script, right-click the script module and click Edit Script. Then, click Yes to confirm the operation. You can make changes to the script in the details pane.

When you are editing the script, a red asterisk is displayed next to the name of the script module in the console tree. This indicates the changes you are making to the script are not saved. You can undo your changes or save them:

  • To undo changes, press CTRL+Z. (The redo function is also available: press CTRL+Y.)
  • To undo all unsaved changes, right-click the script module and click Discard Changes. (This operation is irreversible: if you perform this command, your changes to the script are lost.)
  • To save the changes, right-click the script module and click Save Script on Server.

When the script module is ready, you can proceed to configuring a script policy that will use the prepared script module.

Active Roles allows you to attach a debugger to the Administration Service’s script host for a given policy script or scheduled task script. When the script is being executed by the specified Administration Service, the debugger may help you identify and isolate problems, if any, with the policy or task based on that script.

To enable debugging of a script in the Active Roles console, display the Properties dialog box for the script module containing the script, go to the Debugging tab, and select the Enable debugging check box. From the Debug on server list, select the Administration Service where you want the debugger to run.

Configuring a policy to execute a script

Configuring a policy to execute a script

To configure a script-based policy, select Script Execution on the Select Policy Type page in the New Provisioning Policy Object wizard, in the New Deprovisioning Policy Object wizard, or in the Add Policy wizard. Then, click Next to display the Script Module page.

Figure 78: Script Module: Executing a script

On this page, click Select a script module and select the script module. Then, click Next and follow the instructions in the wizard to create the Policy Object.

Steps for configuring a Script Execution policy

To configure a Script Execution policy

  1. On the Policy to Configure page, select Script Execution, and then click Next.
  2. On the Script Module page, do one of the following:
    • To use an existing script module, click Select a script module, and select the script module in the box beneath this option.
    • To create a new script module, click Create a new script module, and click Next. Then, specify a name for the script module, and click Next. Then, select the event handlers you want the script module to include.
  3. Click Next.
  4. On the Policy Parameters page, do the following:
    1. If necessary, from the Function to declare parameters list, choose the function that defines the parameters specific to this policy.

      The list contains the names of all script functions found in the selected Script Module. The policy has the parameters that are defined by the function specified in the Function to declare parameters box. Normally, this is a function named onInit.

    1. Under Parameter values, view or change the values of the policy parameters. To change the value of a parameter, select the name of the parameter and click Edit.

      Clicking Edit displays a page where you can add, remove, or select a value or values for the selected parameter. For each parameter, the function that is used to declare parameters defines the name of the parameter and other characteristics, such as a description, a list of possible values, the default value, and whether a value is required. If a list of possible values is defined, then you can only select values from that list.

  5. On the Enforce Policy page, you can specify objects to which this Policy Object is to be applied:
    • Click Add, and use the Select Objects dialog box to locate and select the objects you want.
  6. Click Next, and then click Finish.

To create a script module

  1. In the console tree, under Configuration | Script Modules, locate and select the folder in which you want to add the script module.

    You can create a new folder as follows: Right-click Script Modules and select New | Scripts Container. Similarly, you can create a sub-folder in a folder: Right-click the folder and select New | Scripts Container.

  1. Right-click the folder and select New | Script Module.
  2. Specify the name and language of the module to create. Then, click Next.
  3. In Select a script module type, click the type of the module to create. Then, click Next.
  4. If you selected the Policy script type for the module, select the event handlers you want the module to include, and then click Next.
  5. Click Finish.

To edit a script module

  1. In the console tree, expand Configuration | Script Modules.
  2. Under Script Modules, click the folder that contains the script module you want to edit.
  3. In the details pane, right-click the script module, and then click Edit Script.
  4. Use the details pane to make changes to the script.
  5. Right-click the script module in the console tree, and do one of the following:
    • To commit the changes you have made, click Save Script on Server.
    • To quit the script editor without saving your changes, click Discard Changes.

To import a script module

  1. In the console tree, under Configuration | Script Modules, locate and select the folder in which you want to add the script module.

    You can create a new folder as follows: Right-click Script Modules and select New | Scripts Container. Similarly, you can create a sub-folder in a folder: Right-click the folder and select New | Scripts Container.

  1. Right-click the folder, and click Import.
  2. Locate and select the file containing the script to import, and click Open.

To export a script module

  1. In the console tree, expand Configuration | Script Modules.
  2. Under Script Modules, select the folder that contains the script module you want to export.
  3. In the details pane, right-click the script module, and select All Tasks | Export.
  4. Specify the file to which you want to save the script, and then click Save.

Scenario: Restricting group scope

This scenario describes how to configure a policy that prevents creation of universal groups. With this policy, the Active Roles console or Web Interface does not allow an administrator to create a new universal group or convert an existing group to a universal group.

To implement this scenario, you must perform the following actions:

  1. Prepare the script that implements this scenario.
  2. Create and configure the Policy Object to run that script.
  3. Apply the Policy Object to a domain, OU, or Managed Unit.

As a result, the Active Roles console or Web Interface cannot be used to set the universal group scope option when creating a new group or changing an existing group in the container you selected in Step 3. For example, if you choose the Universal option under Group scope and then click Next in the New Object - Group wizard, the Active Roles console presents you with an error message stating that creation of universal groups is not allowed.

The following sections elaborate on the steps to implement this scenario.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating