Auth0 Home Realm Discovery Settings Fail to Save in Connection Profiles
Last Updated:
Overview
Home Realm Discovery (HRD) settings, specifically the domain_aliases field, fail to save when configuring a Connection Profile in Auth0 because the Connection Profiles schema does not support the domain_aliases array. Resolve this issue by applying the HRD domains directly to the Enterprise Connection after the profile provisions the connection. This issue occurs when attempting to configure HRD domains within a Connection Profile via the Auth0 Dashboard, which fails silently. It also occurs when passing domain_aliases during a POST /api/v2/connection-profiles request via the Management API, which returns the following error:
Payload validation error: 'Additional properties not allowed: options' on property connection_config (Connection profile configuration).
Applies To
- Auth0
- Connection Profiles
- Home Realm Discovery (HRD)
- Enterprise Connections
Cause
The Connection Profiles schema does not support the domain_aliases array. Connection Profiles act as templates, and because domain_aliases is not an allowed property in that template schema, the configuration fails.
Solution
Configure the domains via the Auth0 Dashboard.
To properly configure HRD, apply the HRD domains directly to the Enterprise Connection after the profile provisions the connection.
Create the connection and navigate to the Enterprise connection settings in the Auth0 Dashboard to add the HRD domains.
- Create the connection or allow the Connection Profile to generate it.
- Go to Authentication > Enterprise > Specific connection.
- Select the Login Experience tab.
- Enter the domains in the Identity Provider domains box.
Configure the domains via the Management API.
Send a PATCH request to the connections endpoint containing the domain aliases array while retaining all original required options.
- Send a
PATCH /api/v2/connections/<id>request. - Include the
domain_aliasesarray inside theoptionsobject. - Include all other original, required options for that specific connection strategy in the payload to prevent Auth0 from overwriting and deleting them.