Chat now with support
Chat with Support

Please note, you may experience access issues between 6am - 7am Eastern time on Saturday, May 28 2022 due to planned maintenance

Active Roles 7.4.5 - 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 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
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 One Identity Starling Two-factor Authentication for Active Roles Managing One Identity Starling Connect Azure AD, Office 365, and Exchange Online management
Configuring Active Roles to manage hybrid AD objects Managing Hybrid AD Users Office 365 roles management for hybrid environment users Managing Office 365 Contacts Managing Hybrid AD Groups Managing Azure O365 or Unified 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 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: Enabling Federated Authentication Appendix F: Active Roles integration with other One Identity and Quest products Appendix G: Active Roles integration with Duo MFA Appendix H: Active Roles integration with Okta MFA

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.

Scenario: Implementing a Birthday attribute

This scenario illustrates how to create and use a virtual attribute to store information on the birthdays of users.

To create the Birthday attribute

  1. In the console tree, expand Configuration | Server Configuration.
  2. Under Server Configuration, right-click Virtual Attributes, and select New | Virtual Attribute.
  3. Click Next.
  4. In the Common-Name and LDAP Display Name boxes, type Birthday, as shown in the following figure.

    Figure 142: Attribute identification

  1. Click Next.

    The Attribute Syntax page should look as shown in the following figure.

    Figure 143: Attribute syntax

  1. Click Next.
  2. On the Object Classes page, select the check box next to User, as shown in the following figure.

    Figure 144: Object classes

  1. Click Next.
  2. On the Attribute Storage window, select the Store values of this virtual attribute in the Active Roles Administration database check box.
  3. Click Next, and then click Finish to complete the wizard.

To enable the new attribute, reconnect to the Administration Service: right-click the console tree root and click Reconnect.

In the Active Roles console, you can manage the Birthday attribute on a user account as follows:

  1. Right-click the user account and select All Tasks | Advanced Properties.
  2. In the Advanced Properties dialog box, select both the Show all possible attributes and Include attributes with empty values check boxes.
  3. Click Birthday in the list of properties, and then click Edit.
  4. In the Value box, type a birthday date.
  5. Click OK.

You can also manage the Birthday attribute via the Active Roles Web Interface.

First, you need to add the Birthday field to a form that displays user properties, and associate that field with the Birthday attribute. You can accomplish this by customizing the form. For instructions on how to add a field to a form, refer to the Active Roles Web Interface Administration Guide.

Then, the Birthday attribute can be managed by accessing user properties in a Web Interface site. For example, users can view and modify this attribute via Site for Self-Administration, provided that you have self-administration implemented (see Scenario 2: Implementing Self-administration in the Role-based Administration chapter earlier in this document).

Examining client sessions

The Active Roles console displays comprehensive information about client sessions. With the console connected to a given Administration Service, you can examine which clients are using that Service. Session information provided by the console includes the following:

  • User  Logon name of the account used by the session to connect to the Administration Service.
  • Active Roles Admin  Whether or not the client is logged on as a member of the Active Roles Admin account, and thus has administrator rights on the Administration Service.
  • Client Version  Client application, such as MMC Interface or Web Interface, and its version.
  • Last Access Time  Date and time that the Administration Service was last accessed within this session.
  • Logon Time  Date and time that the session was opened.
  • Client Host  DNS name of the computer running the client application.
  • Client Site  Network site of the computer running the client application.

To display a list of client sessions on the Administration Service

  1. Connect to the Administration Service you want to examine for the client sessions.
  2. In the console tree, expand Configuration | Server Configuration, and select Client Sessions.

    As a result, the details pane lists the client sessions for the Administration Service to which the console is connected.

By using the shortcut menu on a client session, you can also perform the following tasks:

  • Send e-mail to the session user.
  • Disconnect the session from the Administration Service.
  • View additional information about the session.

For example, to view additional information about a session, right-click the session in the details pane and click Properties.

The Properties dialog box for a client session includes the following tabs:

  • General  Information about the session user, client version, client host, and client site.
  • Client Activity  Information about logon time, last access time, and the number of operations performed within the session, grouped by operation type.
  • Member Of  List of all security groups computed due to a transitive group membership expansion operation on the session user at the moment of session start.
  • Domain Controllers  Information about the domain controllers used to retrieve and update directory data within the session.

Monitoring performance

Active Roles includes a set of performance counters to monitor various aspects of the Administration Service’s performance. Counters are grouped into performance objects that include the following:

  • Requests  Counts data management requests submitted to the Administration Service.
  • LDAP operations  Counts LDAP requests issued by the Administration Service.
  • Permissions propagation  Counts changes to Active Directory security made by the Administration Service.
  • External changes  Counts data changes polled by the Administration Service from Active Directory, and changes made to the Administration Database.
  • Script modules  Counts the average execution time of Active Roles script modules, the number of times a particular script module was executed, and number of script module instances being currently executed.
  • Miscellaneous  Counts the number of clients connected to the Administration Service and the number of queued post-policy processing operations.

To examine Administration Service performance counters, you can use the Performance tool on the computer running the Administration Service:

  1. Start the Performance tool: click Start and select All Programs | Administrative Tools | Performance.
  2. In the console tree, select System Monitor.
  3. Click in the details pane, and then press CTRL+I to display the Add Counters dialog box.
  4. From the list in the Performance object box, select any name that begins with the prefix AR Server. For example, you might select AR Server:Requests.
  5. Select an item from the list of counters. For example, you might select Requests/sec.
  6. Click Add and then click Close.

As a result, the Performance tool displays the output of the counter you have selected.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating