How to Test New Connections with the Self Service SSO Setup Assistant

[auth0.knowledge2]

Overview

Self-service Single Sign-On (SSO) provides end-users with a setup assistant that guides them in creating their SSO integration. When the setup is completed, the SSO integration is automatically added to the tenant as an Enterprise Connection.

When customers create a self-service SSO for their clients, they want to let them know how to test the new connection. This article shows the assistant’s steps, including the final one, with a button to try the connection (similar to the Auth0 dashboard).

Applies To

• Self-Service Single Sign-On (SSO)
• B2B
• Testing Self-Service SSO new connection
• Self-service SSO setup assistant

Solution

Using Self-Service SSO includes the following tasks:

1. The Auth0 customer creates a self-service profile in their tenant using the Auth0 Dashboard (Authentication > Enterprise > Self Service SSO > Create Profile) or the Management API. These profiles are used to determine key elements of customer implementations, including:

   • Which identity providers customer admins can use for SSO.
   • Which user attributes they must capture through SSO, such as email or family name.
   • Branding options that customize the look and feel of the SSO setup assistant.
     
     

2. Using the Management API, the Auth0 customer creates a self-service access ticket that allows customer admins to configure SSO. With this ticket, the customer admins can either create a new connection or edit an existing connection. To generate a self-service access ticket:

3. Retrieve the ID of the self-service profile you want to associate with the access ticket.

4. Call the SSO Access Ticket endpoint using the ID of the appropriate self-service profile:

   POST /api/v2/self-service-profiles/{id}/sso-ticket

5. The Auth0 customer retrieves the ticket URL from the asset created in the previous step and sends this link to the customer admin.

6. The customer admin launches the SSO setup assistant and follows the steps provided to configure either a new or existing connection.

The SSO setup assistant guides customer admins through the SSO setup process:

1. Follow the ticket link:
   

   

2. Select the Identity Provider:
   

   
   
   The assistant will show specific instructions for creating an application with that provider.

3. If connection_id was provided during ticket creation, the assistant offers Configure Connection. If not, offers a first step: Create an application (with specific instructions for the selected IdP):
   

   

4. Configure mapping:
   

   

5. Assign users:
   

   

6. Last step: try the connection with a test button:
   

   
   
   
   

7. After testing, the assistant shows the user information to confirm the correct attributes are being passed:
   

   

At the end of the process, a new Enterprise connection pointing to the customer’s application is added to the Auth0 tenant.