Chat now with support
Chat with Support

Active Roles 7.6.3 - 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 Using regular expressions Administrative Template Communication ports Active Roles and supported Azure environments Active Roles integration with other One Identity and Quest products Active Roles integration with Duo Active Roles integration with Okta Active Roles Diagnostic Tools Active Roles Add-on Manager

Managed scope to control product usage

The area where Active Roles collects product usage statistics is referred to as managed scope. By default, managed scope comprises all Active Directory domains and AD LDS instances registered with Active Roles. This means that by default product usage statistics includes all enabled user accounts in all managed domains and instances. However, if you don’t use Active Roles to manage a particular domain or instance, or a part of a domain or instance (for example, individual Organizational Units), then you can exclude the entire domain or instance, or a part of a domain or instance, from managed scope.

Active Roles provides a built-in Policy Object allowing you to exclude entire AD domains, AD LDS directory partitions, individual Organizational Units (OUs), or even Managed Units (MUs) from managed scope. This Policy Object is located in the Configuration/Policies/Administration/Builtin container in the Active Roles console, and has the name Built-in Policy - Exclude from Managed Scope. When applied to a container such as an AD domain, AD LDS directory partition, OU or MU, this Policy Object:

  • Stops product usage statistics from counting objects held in that container, and
  • Prevents any changes to the objects held in that container, making the objects available for read access only.

Thus, you can exclude a certain domain from managed scope by applying a Policy Object: Choose the Enforce Policy command on the domain object under the Active Directory node in the Active Roles console, click Add, and select the Built-in Policy - Exclude from Managed Scope Policy Object. This stops product usage statistics from counting objects in that domain, and makes all objects in that domain available for read access only. You will not be able to create new objects (users, groups, computers, and so forth) or make changes to existing objects in that domain by using Active Roles.

After you have excluded a domain from managed scope, you may need to make a particular OU in that domain available for read/write access. You can accomplish this by blocking policy inheritance: In the Active Roles console, choose the Enforce Policy command on the OU and then select the Blocked option next to Built-in Policy - Exclude from Managed Scope. Doing so removes the read-only restriction from the OU and objects it contains, while causing product usage statistics to start counting objects held in that OU.

When you apply the Built-in Policy - Exclude from Managed Scope Policy Object to a Managed Unit, all objects that match the membership rules of that Managed Unit are excluded from managed scope. You can use this option to prevent product usage statistics from counting objects that satisfy certain conditions (for example, user accounts that have a particular country or department setting): Create a Managed Unit with the appropriate membership rules and then apply the Built-in Policy - Exclude from Managed Scope Policy Object to that Managed Unit. Doing so stops product usage statistics from counting objects that match the Managed Unit’s membership rules, while making those objects read-only.

You can determine whether a given object is excluded from managed scope by looking at the Managed field on the Object tab in the Properties dialog box for that object in the Active Roles console or on the General Properties page in the Active Roles Web Interface. If the object is excluded from managed scope, the Managed field reads No; otherwise, the field reads Yes.

Voluntary thresholds for the managed object count

By default, Active Roles does not limit the number of managed objects. However, as Active Roles’ license fee is based on the managed object count, you may need to verify if the object count is under a certain threshold. You can perform this task by specifying a threshold value for the number of managed objects. The scheduled task that counts managed objects then raises an alert each time it detects that the current number of managed objects exceeds the threshold value. The alert makes the Product Usage Statistics section red on the root page in the Active Roles console, and can send a notification over e-mail.

To configure thresholds and notification for the managed object count

  1. Log on as Active Roles Admin, and open the Active Roles console.

    Only members of the Active Roles Admin account are authorized to configure thresholds and notification for the managed object count.

  1. In the console tree, select the root node: Active Roles.
  2. On the page in the details pane, expand the Product Usage Statistics section, and then click Set License threshold value to update the threshold.
  1. In the Threshold Value dialog box that appears, specify the desired threshold value for Active Directory domains (AD DS), AD LDS directory partitions (AD LDS), Azure tenants, or SaaS applications.

    You can specify an AD DS threshold value, AD LDS threshold value, Azure tenant threshold value, and SaaS threshold value independently from each other. Active Roles raises an alert if the total number of managed objects in AD DS, AD LDS directory partitions, Azure tenant, or SaaS application exceeds the corresponding threshold value. If the threshold value is specified for any of these, then Active Roles does not evaluate the managed object counts at all.

  1. If you want Active Roles to notify of the threshold violation alert over e-mail, then, in the Threshold Value dialog box, configure the notification settings as follows:
    1. Select the Notify of threshold violations by e-mail check box.
    2. Click the button next to the Recipients field, and specify who you want to receive the notification messages. You can select recipients from an address book (requires Microsoft Outlook to be configured), or supply individual e-mail addresses.
    3. Click the button next to the E-mail server settings field. Then, on the Mail Setup tab in the dialog box that appears, supply the server name and other settings specific to your outgoing SMTP server.

    If multiple mail configuration objects exist in your Active Roles environment, then you may first need to select the appropriate object from the E-mail server settings list. Mail configuration objects can be created in the Configuration/Server Configuration/Mail Configuration container in the Active Roles console.

  1. When finished, click OK to close the Threshold Value dialog box.

Installation label

The Active Roles console allows you to set a text label that helps you identify your Active Roles installation in the Managed Object Statistics report—a report that lists the managed object counts (see Viewing product usage statistics). You can use the installation label to distinguish, for example, between production and non-production or pilot installations. The label text is displayed in the title of the Managed Object Statistics report.

To set or change the installation label

  1. Log on as Active Roles Admin, and open the Active Roles console.

    Only members of the Active Roles Admin account are authorized to set or change the installation label.

  1. In the console tree, select the root node: Active Roles.
  2. On the page in the details pane, expand the Product Usage Statistics section, and then click the Change link next to the Installation label field.

    The console does not display the Change link unless you are logged on as Active Roles Admin.

  1. In the Installation Label dialog box that appears, type the label text you want, and then click OK.

Creating and using virtual attributes

Active Roles provides the facility to define custom (virtual) attributes for any existing object type. This allows additional object properties to be specified without extending the Active Directory schema. For example, custom attributes can be used to store specific user data.

You can configure a virtual attribute to store the attribute value in the Active Roles database. Otherwise, to use the virtual attribute, you need to implement a script policy to handle the attribute value.

To create a virtual attribute

  1. In the console tree, expand Configuration | Server Configuration.
  2. Under Server Configuration, right-click Virtual Attributes and select New | Virtual Attribute.
  3. Follow the instructions in the Add Virtual Attribute wizard.
  4. In the Common-Name and the LDAP Display Name boxes, type a common name and an LDAP display name for the new attribute.

    In the Unique X.500 object ID box, you can optionally change the default value of the attributeID property (OID) for the new attribute. The default value is generated automatically. If you want to generate your own value, you can use the Oidgen (oidgen.exe) tool, included with the Windows Server Resource Kit.

    In the Schema ID GUID box you can optionally change the default value of the schemaIDGUID property. The default value is generated automatically. If you want the new attribute to have the fixed schemaIDGUID property, replace the default value with your own value. For example, you can generate GUID with the Uuidgen tool, included with the Microsoft Platform SDK.

  1. Optionally, in the Description box, type a description for the new virtual attribute. Click Next.
  2. In the Syntax list, click the syntax you want for the new virtual attribute. If you want the new attribute to be multi-valued, select the Multi-valued check box. Click Next.
  3. Select the check boxes next to the object classes with which you want the virtual attribute to be associated. Click Next.

    If you need the new attribute to be associated with object classes that are not listed by default, select the Show all possible classes check box.

  1. If you want to store the values of the attribute in the Active Roles database, select the check box on the Attribute Storage page.

    If you choose not to store the attribute values in the database, a script policy is required to supply the attribute value when retrieving the attribute and to save the attribute value when updating the attribute.

    However, you should use this option carefully. Storing attribute values in the Active Roles configuration database may considerably increase the database size.

    This option can be modified after the attribute is created, by managing properties of the virtual attribute.

  1. Click Next, and then click Finish to complete the wizard.

After the new virtual attribute has been added, reconnect to the Administration Service. The new virtual attribute appears in the Virtual Attributes container under Configuration/Server Configuration.

To view or modify the value of a virtual attribute on an object

  1. Right-click the object, and select All Tasks | Advanced Properties.
  2. Select the Show all possible attributes and the Include attributes with empty values check boxes, for the list in the Advanced Properties dialog box to display all attributes of the object.
  3. Click the attribute in the list, and then click the button beneath the list.
  4. In the dialog box that opens, view or modify the value of the attribute.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating