Manage relationship-derived virtual properties (RDVPs)

Relationship-derived virtual properties (RDVPs) are managed object properties that display data from a related object. They make it easier to query and display relationship data without needing to traverse the relationship in your query. RDVPs are one type of virtual property available in Advanced Identity Cloud.

An example RDVP uses a user object type with a manager relationship. A managerEmail RDVP pulls the email address from the related manager’s object, so you can display or filter by the manager’s email as if it were a direct property on the user.

Learn more about RDVPs in Relationship-derived virtual properties and Relationships.

This page describes how to add an RDVP from a relationship’s Derived Properties tab. RDVPs created this way are regular virtual properties in the schema and behave the same as those created from a managed object type’s Properties tab. Learn more in Manage custom properties.

Manage RDVPs

To manage RDVPs for a relationship:

In the Advanced Identity Cloud admin console, go to people Identities > Configure.
On the Managed Object Types page, select the object type. For example, select Alpha realm – User.
Click the Relationships tab, and then click the relationship you want to manage RDVPs for.
Click the Derived Properties tab.
On the Derived Properties page, do one of the following:
- To add an RDVP, click add Add Derived Property.
- To modify an RDVP, click () for the RDVP and select edit Edit.
- To delete an RDVP, click () for the RDVP and select delete Delete.

Add RDVPs to a relationship

On the Derived Properties page, click add Add Derived Property for the side of the relationship where you want to add the derived property.
In the Add Derived Property modal, configure the derived property settings and click Add.
To add another derived property to the relationship for the same side of the relationship, click Add and repeat step 2.
To add derived properties to the other side of the relationship, repeat steps 1 - 3.
When you’ve finished adding properties, click Save.

Modify RDVPs on a relationship

On the Derived Properties page, click the ellipsis icon () for the RDVP you want to modify, and select edit Edit.
In the Edit Derived Property modal, modify the derived property settings and click Update.
Click Save.

Delete RDVPs from a relationship

Deleting an RDVP removes the underlying virtual property from the schema. Any queries, scripts, or UI components that reference that property will stop working until they’re updated.

On the Derived Properties page, click the ellipsis icon () for the RDVP you want to delete, and select delete Delete.
Click Delete to confirm the deletion.
Click Save.

Derived property settings reference

Use the following settings in the Add/Edit Derived Property modal to configure an RDVP for a relationship.

RDVPs are typically defined as array properties because a relationship can return multiple related objects. The type and multivalued behavior are determined on the property itself in the managed object schema.

Field, option Description

Name

A unique name for the derived property.

Label (optional)

A human-readable label for the derived property that appears in the UI.

Description (optional)

An optional description for the derived property.

Derive value from

The related property from which to derive the value for the derived property.

Select which fields to project from the related objects. For example, if you have a relationship between a user and their manager, you can derive a managerEmail RDVP by selecting the manager’s mail field.
To derive a property from the entire related managed object type instead of a specific property, select Full [managed object type] Object. For example, you could create a managerDetails property on a user to expose the manager’s full profile (name, email, department, and so on).

Flatten properties

Controls how the RDVP values are represented.

Select this checkbox if you want a simple, query-friendly value instead of full object references.

When not selected (flattenProperties = false), the RDVP returns objects that include _id, _rev, and the referenced fields from the related object.
When selected (flattenProperties = true), the RDVP returns primitive values (for example, just the email addresses or names) instead of full JSON objects. For multivalued RDVPs, this is an array of primitive values instead of an array of objects.

Searchable

By default, RDVPs aren’t searchable. Select this checkbox to make the RDVP searchable in the Advanced Identity Cloud admin console and using the REST API.

Making an RDVP searchable might impact performance, especially if the derived property is based on a relationship with many related objects or if you have a large number of identities in your tenant.

Notify Related Managed Object Type

Specify a related managed object type that will be notified on modification of the properties.

This allows changes to the derived property on one side of a relationship to automatically trigger recalculation of related derived or virtual properties on the other object type.

PingOne Advanced Identity Cloud