Update Connection Display Name for Universal Login Experience

This article provides instructions on how to change the display name of an existing Connection. This name is displayed during the Universal Login experience. The update is performed using the Management API Update a Connection endpoint.

• Connection renaming
• Management API
• Update a Connection endpoint
• Universal Login experience

1. Obtain a Management API Access Token.

2. Identify the ID of the Connection that requires renaming.

3. Identify the endpoint and method for the request: PATCH /api/v2/connections/<connection_id>

   • Replace <connection_id> with the actual ID of the connection.

4. Construct the request body using JavaScript Object Notation (JSON).

   • The new display name must be stored in the display_name field.

   • Include this field in the JSON body of the request with the new desired name.

{
  "display_name": "yourcustomname"
}

NOTE: This procedure updates the display_name field, which controls the connection name displayed exclusively in the new Universal Login experience. The immutable identifier, or technical name, stored in the name field, is not modified.

5. Execute the request by sending the PATCH request to the Update a Connection endpoint. Include the Management API Access Token in the Authorization header (using the Bearer scheme) and the JSON body.

6. An example using curl is provided below:

curl --request PATCH \ --url 'https://<domain>/api/v2/connections/<connection_id>' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <management_api_token>' \ --data '{ "display_name": "NewConnectionDisplayName" }'

7. Replace the following values in the example request:

   • <domain>: The tenant domain (for example, dev-12345.auth0.com).

   • <connection_id>: The ID of the connection.

   • <management_api_token>: The valid Management API token.

8. Verify the update:

   • If successful, the API returns a 200 OK status code and the updated connection object in the response body.

   • Verify the change in the connection list.