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

Creating a Policy Type object

Active Roles stores Policy Type objects in the Policy Types container. You can access that container in the Active Roles Console by expanding the Configuration > Server Configuration branch of the Console tree.

To create a new Policy Type object

  1. In the Console tree, under Configuration/Server Configuration/Policy Types, right-click the Policy Type container in which you want to create a new object, and select New > Policy Type.

    For example, if you want to create a new object in the root container, right-click Policy Types.

  2. In the New Object - Policy Type Wizard, type a name, a display name and, optionally, a description for the new object.

    The display name and description are displayed on the page for selecting a policy, in the wizards that are used to configure Policy Objects.

  3. Click Next.

  4. Click Browse and select the Script Module containing the script that will be run by the policies of this policy type.

    The Script Module must exist under the Configuration/Script Modules container and hold a policy script. For information about policy scripts, see the Active Roles SDK documentation.

  1. In the Policy Type category area, do one of the following:

    1. Click Provisioning if policies of this type are intended for Policy Objects of the provisioning category.

    2. Click Deprovisioning if policies of this type are intended for Policy Objects of the deprovisioning category.

    The policy types that have the Provisioning option selected appear on the page for selecting a policy in the wizard that is used to create a provisioning Policy Object or to add policies to an existing provisioning Policy Object. The policy types that have the Deprovisioning option selected appear in the wizard for creating a deprovisioning Policy Object or adding policies to such a Policy Object.

  2. From the Function to declare parameters list, select the name of the script function that defines the parameters specific to this type of administration policy.

    The list contains the names of all the functions found in the script you selected in Step 4. Every policy of this type will have the parameters that are specified by the function you select from the Function to declare parameters list. Normally, this is a function named onInit (see the Active Roles SDK documentation).

  3. Click Policy Type Icon to verify the image that denotes this type of policy. To choose a different image, click Change and open an icon file containing the image you want.

    This image appears next to the display name of the policy type on the wizard page for selecting a policy to configure, to help identify and visually distinguish this policy type from the other policy types.

    The image is stored in the Policy Type object. In the dialog that appears when you click Policy Type Icon, you can view the image that is currently used. To revert to the default image, click Use Default Icon. If the button is unavailable, then the default image is currently used.

  4. Click Next and follow the steps in the wizard to complete the creation of the new Policy Type object.

Changing an existing Policy Type object

You can change an existing Policy Type object by changing the general properties, script, category, or icon. The general properties include the name, display name, and description. The Policy Type objects are located under Configuration/Server Configuration/Policy Types in the Active Roles Console.

The following table summarizes the changes you can make to an existing Policy Type object, assuming that you have found the object in the Active Roles Console.

Table 51: Changing an existing Policy Type object

To change

Do this

Commentary

Name of the object

Right-click the object and click Rename.

The name is used to identify the object, and must be unique among the objects held in the same Policy Type container.

Display name or description

Right-click the object, click Properties and make the necessary changes on the General tab.

Changing the display name or description also changes the policy name or description on the page for selecting a policy in the Policy Object management wizards.

Script Module

Right-click the object, click Properties, click the Script tab, click Browse, and then select the Script Module you want.

You can change the script in the Script Module that is currently associated with the Policy Type object instead of selecting a different Script Module. To view or change the script, find and select the Script Module in the Active Roles Console tree, under Configuration/Script Modules.

Changing the script affects all the existing policies of this policy type. If you add a policy to a Policy Object and then change the script for the Policy Type object based on which the policy was created, the policy will run the changed script.

Policy Type category

Right-click the object, click Properties, click the Script tab, and then click either Provisioning or Deprovisioning.

Changing this option changes the appearance of the respective policy type in the Policy Object management wizards. For example, once the option has been changed from Provisioning to Deprovisioning, the policy type is no longer displayed in the wizard for configuring a provisioning Policy Object; instead, it appears in the wizard for configuring a deprovisioning Policy Object.

However, changing the Policy Type category does not affect the existing policies of this policy type. For example, once a policy is added to a provisioning Policy Object, the policy is retained in that Policy Object after changing the Policy Type category from Provisioning to Deprovisioning in the respective Policy Type object.

Function to declare parameters

Right-click the object, click Properties, click the Script tab, and then choose the appropriate function from the Function to declare parameters list.

Changing this setting changes the list of the policy parameters specific to this policy type. The changes do not affect the parameters of the existing policies of this type. When you add a new policy based on this policy type, the list of the policy parameters is built using the new function to declare parameters.

Policy Type icon

Right-click the object, click Properties, click the Script tab, click Policy Type Icon, and then do one of the following:

  • Click Change and open an icon file containing the image you want.

  • Click Use Default Icon to revert to the default image.

Changing this setting changes the image that appears next to the display name of the policy type in the Policy Object management wizards, on the page that prompts you to select a policy to configure.

Using Policy Type containers

You can use a Policy Type container to store related Policy Type objects and other Policy Type containers.

Containers give you an additional way to categorize custom policy types, making it easier to locate and select the policy to configure in the wizards for managing Policy Objects. Thus, when you create a Policy Object, the wizard page that prompts you to select a policy displays the custom policy types along with the containers that hold the respective Policy Type objects.

To create a new Policy Type container

  1. In the Console tree, under Configuration/Server Configuration/Policy Types, right-click the Policy Type container in which you want to create a new container, and select New > Policy Type Container.

    For example, if you want to create a new container in the root container, right-click Policy Types.

  2. In the New Object - Policy Type Container Wizard, type a name and, optionally, a description for the new container.

    The name and description are displayed on the page for selecting a policy, in the wizards that are used to configure Policy Objects.

  3. Click Next and follow the steps in the wizard to complete the creation of the new container.

Exporting policy types

You can export Policy Type objects so that the definition of the policy types is stored in an XML file that can be imported in a different Active Roles environment. Exporting and then importing Policy Type objects make it easy to distribute custom policies to other environments.

To export a Policy Type object or container

  • Right-click the Policy Type object or container, click Export and specify a file to hold the export data.

You can select multiple Policy Objects to export, or you can select a container to export all Policy Type objects and containers held in that container. In either case, the Export operation creates a single XML file that can later be imported to any container under the Policy Types node.

Exporting Policy Type objects creates an XML file representing both the objects and the Script Modules containing the policy scripts for each policy type being exported. During an import, Active Roles creates the Policy Type objects and the Script Modules based on the data found in the XML file. As a result of the import, the policy types are replicated to the new environment and can be used the same way as in the environment from which they were exported.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating