Chat now with support
Chat with Support

Active Roles 8.1.1 - Administration Guide

Introduction 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
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 Configure 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 Azure AD, Microsoft 365, and Exchange Online Management
Configuring Active Roles to manage Hybrid AD objects Managing Hybrid AD users
Creating a new Azure AD user with the Web Interface Viewing or updating the Azure AD user properties with the Web Interface Viewing or modifying the manager of a hybrid Azure user Disabling an Azure AD user Enabling an Azure AD user Deprovisioning of an Azure AD user Undo deprovisioning of an Azure AD user Adding an Azure AD user to a group Removing an Azure AD user from a group View the change history and user activity for an Azure AD user Deleting an Azure AD user with the Web Interface Creating a new hybrid Azure user with the Active Roles Web Interface Converting an on-premises user with an Exchange mailbox to a hybrid Azure user Licensing a hybrid Azure user for an Exchange Online mailbox Viewing or modifying the Exchange Online properties of a hybrid Azure user Creating a new Azure AD user with Management Shell Updating the Azure AD user properties with the Management Shell Viewing the Azure AD user properties with the Management Shell Delete an Azure AD user with the Management Shell Assigning Microsoft 365 licenses to new hybrid users Assigning Microsoft 365 licenses to existing hybrid users Modifying or removing Microsoft 365 licenses assigned to hybrid users Updating Microsoft 365 licenses display names
Unified provisioning policy for Azure M365 Tenant Selection, Microsoft 365 License Selection, Microsoft 365 Roles Selection, and OneDrive provisioning Microsoft 365 roles management for hybrid environment users Managing Microsoft 365 contacts Managing Hybrid AD groups Managing Microsoft 365 Groups Managing cloud-only distribution groups Managing cloud-only dynamic distribution groups Managing Azure security 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
Modern Authentication 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 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

Configuring a Create activity

When you configure a Create activity, you can specify the Organizational Unit or container where you want the activity to create objects, choose the object type and name, and specify how you want the activity to populate the properties of the newly-created objects. Additional options are available such as notification, error handling, and “Run as” options.

To configure a Create activity

  1. In the Active Roles Console tree, expand Configuration > Policies > Workflow, and select the workflow containing the Create activity you want to configure.

    This opens the Workflow Designer window in the details pane, representing the workflow definition as a process diagram.

  2. In the process diagram, right-click the name of the activity and click Properties.

  3. Navigate to the Container tab in the “Create” Activity Properties dialog.

  4. Click in the Activity creates the object in this container box to specify the Organizational Unit (OU) or container in which you want the activity to create an object. The following options are available:

    • Fixed container in directory: With this option, the activity creates an object in the given OU or container. You can select the desired OU or container in Active Directory when you configure the activity.

    • Parent OU of workflow target object: With this option, the activity creates an object in the OU that holds the target object of the request that started the workflow. This option is unavailable in case of an automation workflow.

    • Activity target object: With this option, the activity creates an object in the OU or container created or otherwise processed by another CRUD activity at the time of executing the workflow. You can select the desired CRUD activity from the workflow definition when you configure the activity.

    • Object identified by workflow parameter: With this option, the activity creates an object in the OU or container specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the activity.

    • Object from workflow data context: With this option, the activity creates an object in the OU or container that is selected by the Create activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring a Create activity, you can specify which OU or container you want the activity to select at workflow run time.

    • Object identified by DN-value rule expression: With this option, the activity creates an object in the OU or container whose Distinguished Name (DN) is specified by the string value of a certain rule expression. By using a rule expression you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when you configure the activity.

  5. Navigate to the Object name tab in the “Create” Activity Properties dialog.

  6. Click in the Object type box, and select the type of the objects you want the activity to create, such as User, Group, Computer, and so forth.

  7. Click in the Object name box to specify how you want the activity to generate the object name when creating an object. The following options are available:

    • Text string: With this option, the activity uses the given string of characters as the name of the object. You can specify the desired string when you configure the activity.

    • Name of workflow target object: With this option, the activity uses the name of the target object of the request that started the workflow. This option is unavailable in case of an automation workflow.

    • Name of workflow target object, followed by text string: With this option, the activity uses a certain text string prefixed with the name of the target object of the request that started the workflow. You can specify the desired text string when you configure the activity. This option is unavailable in case of an automation workflow.

    • Workflow parameter value: With this option, the activity uses the name specified by the string value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the activity.

    • Property of object from workflow data context: With this option, the activity uses the name identified by the value of a certain property of the object that will be selected by the Create activity on the basis of the data found in the workflow environment at the time of executing the workflow. When you configure a Create activity, you can choose the desired property and specify which object you want the activity to select at workflow run time.

    • Value generated by rule expression: With this option, the activity uses the name identified by the string value of a certain rule expression. By using a rule expression you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when you configure the activity.

  8. Navigate to the Object properties tab in the “Create” Activity Properties dialog.

  9. Configure the list of the properties you want the activity to populate:

    • To add a property to the list, click Add property, and then select the name of the desired property.

    • To remove a property from the list, click the Delete button labeled X on the right side of the list item representing that property.

  10. After you have added a property to the list, click in the Value filed to specify the value you want the activity to assign to that property of the newly created object. The following options are available:

    • Text string: With this option, the activity assigns the given string of characters to the property. You can specify the desired string when you configure the activity.

    • Property of workflow target object: With this option, the activity assigns the value of a certain property of the target object of the request that started the workflow. You can select the desired property when you configure the activity. This option is unavailable in case of an automation activity.

    • Property of workflow initiator: With this option, the activity assigns the value of a certain property of the user whose request started the workflow. You can select the desired property when you configure the activity.

    • Changed value of workflow target object property: With this option, the activity assigns the value that is requested to be assigned to a certain property of the workflow target object. You can select the desired property when you configure the activity. This option is unavailable in case of an automation activity.

    • Workflow parameter value: This option causes the activity to populate the property with the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the activity.

    • Property of object from workflow data context: This option causes the activity to populate the property with the value of a certain property of the object that will be selected by the Create activity on the basis of the data found in the workflow environment at the time of executing the workflow. When you configure a Create activity, you can choose the desired property and specify which object you want the activity to select at workflow run time.

    • Value generated by rule expression: This option causes the activity to populate the property with the string value of a certain rule expression. By using a rule expression you can compose a string value based on properties of various objects found in the workflow environment at the time of running the workflow. You can create the desired rule expression when you configure the activity.

  11. View or change notification settings. For more information, see Configuring a notification for a CRUD activity.
  12. View or change error handling settings. For more information, see Configuring error handling for a CRUD activity.
  13. View or change the "Run as" options. For more information, see Configuring “Run as” options for a CRUD activity.
  14. View or change additional settings. For more information, see Configuring additional settings for a CRUD activity.

Configuring an Update activity

When you configure an Update activity, you can specify the rules for selecting the object whose properties you want the activity to change, and define how you want the activity to change the properties of the object. Additional options are available such as notification, error handling, and “Run as” options.

To configure an Update activity

  1. In the Active Roles Console tree, expand Configuration > Policies > Workflow, and select the workflow containing the Update activity you want to configure.

    This opens the Workflow Designer in the Details pane, representing the workflow definition as a process diagram.

  2. In the process diagram, right-click the name of the activity and click Properties.

  3. Navigate to the Activity target tab in the “Update” Activity Properties dialog.

  4. Click in the Activity performs the operation on this object box to specify the object whose properties you want the activity to change. This object is referred to as activity target. You can choose from the following options to specify the activity target:

    • Fixed object in directory: The activity target is the given object. You can select the desired object in Active Directory when you configure the activity.

    • Object identified by workflow parameter: The activity target is the object specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the activity.

    • Object from workflow data context: The activity target is selected by the activity on the basis of the data found in the workflow environment at the time of running the workflow. When configuring an Update activity, you can specify which object you want the activity to select at workflow run time.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the activity target is specified by the string value of a certain rule expression. By using a rule expression you can compose a string value based on properties of various objects found in the workflow environment at the time of running the workflow. You can create the desired rule expression when you configure the activity.

  5. Navigate to the Target properties tab in the “Update” Activity Properties dialog.

  6. Configure the list of the properties you want the activity to modify:

    • To add a property to the list, click Add property, and then select the name of the desired property.

    • To remove a property from the list, click Delete labeled X on the right side of the list item representing that property.

  7. After you have added a property, click in the Action field to specify the type of the changes you want the activity to make to that property:

    • Click Set to have the activity assign a new value to the property.

    • Click Clear to have the activity remove the property from the object.

    • In case of a multi-value property, click Add value or Remove value for the activity to add or remove the value of the property.

  8. If an action other than Clear is selected in the Action field, click in the Value filed to specify the property value you want the activity to set, add or remove. The following options are available:

    • Text string: Use the given string of characters as the value of the property. You can specify the desired string when you configure the activity.

    • Property of workflow target object: Use the value of a certain property of the target object of the request that started the workflow. You can select the desired property when you configure an Update activity. This option is unavailable in case of an automation workflow.

    • Property of workflow initiator: Use the value of a certain property of the user whose request started the workflow. You can select the desired property when you configure the activity.

    • Changed value of workflow target object property: Use the value that is requested to be assigned to a certain property of the workflow target object. You can select the desired property when you configure the activity. This option is unavailable in case of an automation workflow.

    • Workflow parameter value: Use the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the activity.

    • Property of object from workflow data context: Use the value of a certain property of the object that will be selected by the Update activity on the basis of the data found in the workflow environment at the time of running the workflow. When you configure the Update activity, you can choose the desired property and specify which object you want the activity to select at workflow run time.

    • Value generated by rule expression: Use the string value of a certain rule expression. By using a rule expression you can compose a string value based on properties of various objects found in the workflow environment at the time of running the workflow. You can create the desired rule expression when you configure the activity.

  9. View or change notification settings. For more information, see Configuring a notification for a CRUD activity.
  10. View or change error handling settings. For more information, see Configuring error handling for a CRUD activity.
  11. View or change the "Run as" options. For more information, see Configuring “Run as” options for a CRUD activity.
  12. View or change additional settings. For more information, see Configuring additional settings for a CRUD activity.

Configuring an “Add to group” activity

When you configure an Add to group activity, you can specify the rules for selecting the object you want the activity to add to groups, and define the groups to which you want the activity to add the object. Additional options are available such as notification, error handling, and “Run as” options.

To configure an Add to group activity

  1. In the Active Roles Console tree, expand Configuration > Policies > Workflow, and select the workflow containing the Add to group activity you want to configure.

    This opens the Workflow Designer in the Details pane, representing the workflow definition as a process diagram.

  2. In the process diagram, right-click the name of the activity and click Properties.

  3. Navigate to the Activity target tab in the “Add to Group” Activity Properties dialog.

  4. Click in the Activity performs the operation on this object box to specify the object you want the activity to add to groups. This object is referred to as activity target. You can choose from the following options to specify the activity target:

    • Fixed object in directory: The activity target is the given object. You can select the desired object in Active Directory when you configure the Add to group activity.

    • Object identified by workflow parameter: The activity target is the object specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the Add to group activity.

    • Object from workflow data context: The activity target is selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring the Add to group activity, you can specify which object you want the activity to select at workflow run time.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the activity target is specified by the string value of a certain rule expression. By using a rule expression you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when, you configure the Add to group activity.

  5. Navigate to the Groups tab in the “Add to Group” Activity Properties dialog.

  6. Configure the list of groups to which you want the activity to add the target object.

    To add a group to the list, click Add group, and then choose from the following options:

    • Fixed group in directory: You can select the desired group in Active Directory when you configure the Add to group activity. A unique identifier of the group is saved in the configuration of the activity. The activity uses that identifier to select the group when calculating the list of groups at workflow execution time.

    • Object from workflow data context: The group is selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring the Add to group activity, you can specify which group you want the activity to select at workflow execution time.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the group is specified by the string value of a certain rule expression. By using a rule expression, you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when you configure the Add to group activity.

    To remove a group from the list, click the Delete button labeled X on the right side of the list item representing that group.

  7. View or change notification settings. For more information, see Configuring a notification for a CRUD activity.
  8. View or change error handling settings. For more information, see Configuring error handling for a CRUD activity.
  9. View or change the "Run as" options. For more information, see Configuring “Run as” options for a CRUD activity.
  10. View or change additional settings. For more information, see Configuring additional settings for a CRUD activity.

Configuring a Remove from group activity

When you configure a Remove from group activity, you can specify the rules for selecting the object you want the activity to remove from groups, and define the groups from which you want the activity to remove the object. Additional options are available, such as notification, error handling, and “Run as” options.

To configure a Remove from group activity

  1. In the Active Roles Console tree, expand Configuration > Policies > Workflow, and select the workflow containing the Remove from group activity you want to configure.

    This opens the Workflow Designer in the Details pane, representing the workflow definition as a process diagram.

  2. In the process diagram, right-click the name of the activity and click Properties.

  3. Navigate to the Activity target tab in the “Remove from Group” Activity Properties dialog.

  4. Click in the Activity performs the operation on this object box to specify the object you want the activity to remove from groups. This object is referred to as the activity target. You can choose from the following options to specify the activity target:

    • Fixed object in directory: The activity target is the given object. You can select the desired object in Active Directory when you configure the Remove from group activity.

    • Object identified by workflow parameter: The activity target is the object specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the Remove from group activity.

    • Object from workflow data context: The activity target is selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring the Remove from group activity, you can specify which object you want the activity to select at workflow run time.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the activity target is specified by the string value of a certain rule expression. By using a rule expression, you can compose a string value based on properties of various objects found in the workflow environment at the time of executing the workflow. You can create the desired rule expression when you configure the Remove from group activity.

  5. Navigate to the Groups tab in the “Remove from Group” Activity Properties dialog.

  6. Choose from these options:

    • Remove the object from all groups: This option configures the activity to remove the object from all groups in Active Directory.

      NOTE: You cannot remove objects from their primary groups. Instead, the activity will remove the object from all groups except its primary group.

    • Remove the object from these groups: This option lets you list the groups from which you want the activity to remove the object. For each of the groups in the list (with the exception of the object’s primary group), the activity will remove the object from that group.

  7. If you chose the option Remove the object from these groups, configure the list of groups from which you want the activity to remove the target object. To add a group to the list, click Add group, and then choose from the following options:

    • Fixed group in directory: You can select the desired group in Active Directory when you configure the Remove from group activity. A unique identifier of the group is saved in the configuration of the activity. The activity uses that identifier to select the group when calculating the list of groups at workflow runtime.

    • Object from workflow data context: The group is selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. When configuring the Remove from group activity, you can specify which group you want the activity to select at workflow runtime.

    • Object identified by DN-value rule expression: The Distinguished Name (DN) of the group is specified by the string value of a certain rule expression. By using a rule expression, you can compose a string value based on properties of various objects found in the workflow environment at the time of running the workflow. You can create the desired rule expression when you configure the Remove from group activity.

    To remove a group from the list, click X on the right side of the list item representing that group.

  8. View or change notification settings. For more information, see Configuring a notification for a CRUD activity.
  9. View or change error handling settings. For more information, see Configuring error handling for a CRUD activity.
  10. View or change the "Run as" options. For more information, see Configuring “Run as” options for a CRUD activity.
  11. View or change additional settings. For more information, see Configuring additional settings for a CRUD activity.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating