立即与支持人员聊天
与支持团队交流

Active Roles 8.1.5 - Administration Guide

Introduction Getting started with Active Roles Configuring rule-based administrative views Configuring role-based administration Rule-based autoprovisioning and deprovisioning
Provisioning Policy Objects Deprovisioning Policy Objects How Policy Objects work Policy Object management tasks Policy configuration tasks
Property Generation and Validation User Logon Name Generation Group Membership AutoProvisioning Exchange Mailbox AutoProvisioning AutoProvisioning in SaaS products OneDrive Provisioning Home Folder AutoProvisioning Script Execution Microsoft 365 and Azure Tenant Selection E-mail Alias Generation 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
Using rule-based and role-based tools for granular administration Workflows
Key workflow features and definitions About workflow processes Workflow processing overview Workflow activities overview Configuring a workflow
Creating a workflow definition for a workflow 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
Approval workflow Email-based approval Automation workflow Activity extensions
Temporal Group Memberships Group Family Dynamic groups Active Roles Reporting Management History Entitlement profile Recycle Bin AD LDS data management One Identity Starling Join and configuration through Active Roles Managing One Identity Starling Connect Configuring linked mailboxes with Exchange Resource Forest Management Configuring remote mailboxes for on-premises users Migrating Active Roles configuration with the Configuration Transfer Wizard Managing Skype for Business Server with Active Roles
About Skype for Business Server User Management Active Directory topologies supported by Skype for Business Server User Management User Management policy for Skype for Business Server User Management Master Account Management policy for Skype for Business Server User Management Access Templates for Skype for Business Server Configuring the Skype for Business Server User Management feature Managing Skype for Business Server users
Exchanging provisioning information with Active Roles SPML Provider Monitoring Active Roles with Management Pack for SCOM Configuring Active Roles for AWS Managed Microsoft AD Azure AD, Microsoft 365, and Exchange Online Management
Configuring Active Roles to manage Hybrid AD objects Unified provisioning policy for Azure M365 Tenant Selection, Microsoft 365 License Selection, Microsoft 365 Roles Selection, and OneDrive provisioning Changes to Active Roles policies for cloud-only Azure objects
Managing the configuration of Active Roles
Connecting to the Administration Service 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 Using regular expressions Administrative Template Configuring federated authentication Communication ports Active Roles and supported Azure environments Integrating Active Roles with other products and services Active Roles Language Pack Active Roles Diagnostic Tools Active Roles Add-on Manager

Script Execution

Script execution policies help you run supplementary PowerShell (or other) script modules in Active Roles during or after performing certain administrative operations. When linking a custom script to an administrative operation via a Script Execution policy, the script will receive control in Active Roles either when the operation is requested or when it is completed.

Use Script Execution policies to set up custom scripts (residing in Script Modules in the Active Roles Console) to:

  • Trigger additional actions when performing directory object provisioning.

  • Regulate object data format and requirements (such as for generating user passwords).

  • Further automate administrative tasks.

Example use case for a Script Execution policy

Consider a scenario where employees of an organization are frequently transferred among its office branches temporarily due to various projects.

To administer such temporary assignments quickly and efficiently, write and apply a custom script that automatically reassigns the employee's user account from the OU of their original office to the OU of their new office, whenever their City or Office Location attributes are updated in Active Roles.

For more information on how to set up a Script Execution policy, see Configuring a Script Execution policy.

TIP: Consider the following when planning to use custom scripts for your provisioning policies:

  • To help you configure Script Execution policies, Active Roles also ships with several built-in Script Modules that you can use to set up your own Script Execution policies. Find these built-in Script Modules in the following node of the Active Roles Console:

    Configuration > Script Modules > Builtin

  • If the directory of your organization contains any cloud-only Azure users, then use the built-in Generate User Password - Azure only script module to set up a password generation policy for cloud-only Azure users that meets the password strength criteria of both your organization and Microsoft Azure Active Directory (Azure AD).

NOTE: Policy Object settings specific to Azure cloud-only objects (such as cloud-only Azure users, guest users, or contacts) are available only if your Active Roles deployment is licensed for managing cloud-only Azure objects. Contact One Identity support for more information.

Also, Policy Objects specific to Azure cloud-only objects will work correctly only if an Azure tenant is already configured in the AD of the organization, and Active Roles is already set as a consented Azure application for that Azure tenant. For more information on these settings, see Configuring a new Azure tenant and consenting Active Roles as an Azure application.

How the Script Execution policy works

Active Roles executes the script module specified in the policy when the operation is requested or after the operation is completed. The script module is stored in the Active Roles configuration database.

Configuring a Script Execution policy

When configuring a Script Execution policy, you can prepare a script module beforehand. Alternatively, you can create an empty script module when configuring a policy, and later you can edit the module and add a script to be used by the policy.

To configure a Script Execution policy

  1. On the Policy to Configure page, select Script Execution, 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 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. (Optional) 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.

    2. 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 will be applied. To do so, click Add, and use the Select Objects dialog to locate and select the objects you want.

  6. Click Next, 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.

    To create a new folder, right-click Script Modules and select New > Scripts Container. Similarly, you can create a sub-folder in a folder by right-clicking the folder and selecting New > Scripts Container.

  2. Right-click the folder and select New > Script Module.

  3. Specify the name and language of the module to create. Then, click Next.

  4. In Select a script module type, click the type of the module to create. Then, click Next.

  5. If you selected the Policy script type for the module, select the event handlers you want the module to include, then click Next.

  6. 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, 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.

    To create a new folder, right-click Script Modules and select New > Scripts Container. Similarly, you can create a sub-folder in a folder by right-clicking the folder and selecting New > Scripts Container.

  2. Right-click the folder, and click Import.

  3. 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, then click Save.

Importing a script

To import a script file, in the Console tree, right-click Script Modules, and click Import. This displays the Import Script dialog where you can select and open a script file.

相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级