Chat now with support
Chat with Support

Active Roles 7.6.2 - 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 Office 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

Configure additional settings

By using additional settings, you can configure a Search activity to stop the search if the number of the objects that meet the search conditions exceeds a certain threshold. It is also possible to modify behavior of a Search activity using so-called request controls to pass additional information to Active Roles on how to process operation requests created by that activity.

To configure additional settings for a Search activity

  1. In the process diagram, right-click the name of the Search activity and click Properties.
  2. Click the Additional settings hyperlink at the bottom of the “Search” Activity Properties dialog box.
  3. To have the Search activity stop the search if the number of the objects found by the search exceeds a certain threshold, select the Terminate the search activity if the search returns more than check box, and specify the maximum number of objects the activity is allowed to return when performing a search.
  4. Add, change, or remove request controls in the Include or exclude these controls from the activity operation requests list.

    To add or change a control, click Add or Change, and then, in the dialog box that opens, specify the name and, if applicable, the value of the control. If you want the activity to add the control to the requests, click Include this control in the activity operation requests. If you want to ensure that the control never occurs in the requests created by this activity, click Exclude this control from the activity operation requests.

Request controls are certain pieces of data in an operation request that can be used to pass additional information to Active Roles on how to process the request. Request controls are optional. If no request controls are added to a request, then Active Roles determines how to process the request based solely on the type of the request. For information about request controls, see the Active Roles SDK documentation.

Configuring CRUD activities

Active Roles offers a number of workflow activities, collectively referred to as CRUD activities, intended to create new objects, and modify or delete existing objects in Active Directory. The CRUD abbreviation designates the key operations that can be performed by using these activities: Create, Read, Update, Delete. The topics in this section provide instructions on how to configure the following CDUD activities:

The following topics in this section provide the steps for configuring the settings that are common to CRUD activities:

“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.

  1. In the process diagram, right-click the name of the activity and click Properties.
  2. Go to the Container tab in the “Create” Activity Properties dialog box.
  3. 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.
  4. Go to the Object name tab in the “Create” Activity Properties dialog box.
  5. 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.
  6. 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.
  7. Go to the Object properties tab in the “Create” Activity Properties dialog box.
  8. 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.
  9. 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 executing the workflow. You can create the desired rule expression when you configure the activity.
  10. View or change notification settings. For instructions, see Configuring notification.
  11. View or change error handling settings. For instructions, see Configuring error handling.
  12. View or change "run as" options. For instructions, see Configuring “run-as” options.
  13. View or change advanced settings. For instructions, see Configuring additional settings.

“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 window in the details pane, representing the workflow definition as a process diagram.

  1. In the process diagram, right-click the name of the activity and click Properties.
  2. Go to the Activity target tab in the “Update” Activity Properties dialog box.
  3. 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 executing 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 executing the workflow. You can create the desired rule expression when you configure the activity.
  4. Go to the Target properties tab in the “Update” Activity Properties dialog box.
  5. 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 the Delete button labeled X on the right side of the list item representing that property.
  6. 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.
  7. 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 executing 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 executing the workflow. You can create the desired rule expression when you configure the activity.
  8. View or change notification settings. For instructions, see Configuring notification.
  9. View or change error handling settings. For instructions, see Configuring error handling.
  10. View or change “run as” options. For instructions, see Configuring “run-as” options.
  11. View or change advanced settings. For instructions, see Configuring additional settings.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating