--- title: Manage custom relationship properties description: Custom relationship properties allow you to define custom relationships between managed objects. For example, you could model a parent-child relationship by creating the custom_Parents and custom_Children properties and configuring them as one-way one-to-many relationships. component: pingoneaic page_id: pingoneaic:idm-objects:relationships-custom canonical_url: https://docs.pingidentity.com/pingoneaic/idm-objects/relationships-custom.html keywords: ["Data Object Model", "Relationships"] page_aliases: ["release-notes:rapid-channel/custom-relationships-schema.adoc"] section_ids: custom-relationships-legacy: Manage custom relationships in the IDM native admin console create_a_custom_relationship: Create a custom relationship update_a_custom_relationship: Update a custom relationship delete_a_custom_relationship_property: Delete a custom relationship property --- # Manage custom relationship properties Custom relationship properties allow you to define custom relationships between managed objects. For example, you could model a parent-child relationship by creating the `custom_Parents` and `custom_Children` properties and configuring them as one-way one-to-many relationships. You can manage relationships in the following ways: * The Advanced Identity Cloud admin console (recommended). Learn more in [Configure relationships](../identities/configure-relationships.html). * The [IDM native admin console](#custom-relationships-legacy) * The Schema API. Learn more in [Schema](../idm-rest-api/endpoints/rest-schema.html). | | | | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | Only use the Advanced Identity Cloud admin console, IDM native admin console, or the Schema API to manage relationships. Using other methods might cause your data to de-sync. | ## Manage custom relationships in the IDM native admin console ### Create a custom relationship To create a custom relationship property using the Advanced Identity Cloud admin console: 1. In the Advanced Identity Cloud admin console, click Native Consoles > Identity Management. 2. From the top navigation menu, click Configure > Managed Objects. 3. Select a managed object type. 4. Click Add a Property. An entry field displays. 5. In the Name field, enter a name for the custom relationship property. The name must begin with the string `custom_`, such as `custom_Example`. 6. From the Type drop-down, select Relationship. 7. Click Next. The Add Resources modal displays. 8. From the Resource drop-down, select the resource to map the custom relationship property to. 9. From the Display Properties drop-down, select the properties on the resource to map to the custom relationship property. 10. Click Save. The Relationships Property screen for the new relationship property displays. | | | | - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | Objects are limited to 10 custom relationships. If you need an object to have more, create custom relationships from the related object and map them to the original object. | ### Update a custom relationship You can adjust a custom relationship's **cardinality** by configuring each side of the relationship to have one, many, or none of the other side. For instance, `custom_Managers` might have many `custom_Employees`, while `custom_Employees` have only one `custom_Managers`. To change the cardinality of a custom relationship using the Advanced Identity Cloud admin console: 1. In the Advanced Identity Cloud admin console, click Native Consoles > Identity Management. 2. From the top navigation menu, click Configure > Managed Objects. 3. Click the managed object type which has the relationship property to modify. 4. Click the relationship property to modify. 5. In the Relationship Configuration section, click the cardinality relationship name associated with the arrow indicating the direction of the relationship. A popover displays. 6. From the Relationship drop-down on the popover, select the cardinality of the relationship. The Changes Pending notification displays in the lower left of the UI. 7. Click Save. | | | | - | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | When you change the configuration of a custom relationship, existing objects which contain that custom relationship aren't automatically updated to match the new configuration. Ensure your data is updated to reflect the new relationship configuration.For example, suppose `custom_Doctors` have many `custom_Patients` and `custom_Patients` have many `custom_Doctors`. The rules change and now `custom_Patients` have one `custom_Doctor`. In addition to updating the custom relationship's cardinality in the configuration, you must also update all existing `custom_Patients` with more than one `custom_Doctor` to have at most one. | ### Delete a custom relationship property Existing objects are not automatically updated when you delete a custom relationship property. When you delete a custom relationship property, you must also update the existing objects to no longer reference them. Failing to do this may result in the "orphaned" data unpredictably reappearing if Advanced Identity Cloud reuses the deleted reference attribute for other data. Before you delete a custom relationship property, find all the managed objects in the custom relationship and either modify or delete the data. The following REST API query returns all managed users with the property `custom_Example`: ``` curl \ --header "Authorization: Bearer " \ --header "Accept-API-Version: resource=2.0" \ --request GET \ "https:///openidm/managed/user?_queryFilter=/custom_Example+pr&_pageSize=30" ``` For more information on using the REST API to manage custom relationship properties, refer to [Schema](../idm-rest-api/endpoints/rest-schema.html).