diff --git a/en/identity-server/next/docs/assets/img/guides/idp/test-connection/test-connection-button.png b/en/identity-server/next/docs/assets/img/guides/idp/test-connection/test-connection-button.png new file mode 100644 index 0000000000..becbc40119 Binary files /dev/null and b/en/identity-server/next/docs/assets/img/guides/idp/test-connection/test-connection-button.png differ diff --git a/en/identity-server/next/docs/assets/img/guides/idp/test-connection/test-connection-results.png b/en/identity-server/next/docs/assets/img/guides/idp/test-connection/test-connection-results.png new file mode 100644 index 0000000000..230a39dc6d Binary files /dev/null and b/en/identity-server/next/docs/assets/img/guides/idp/test-connection/test-connection-results.png differ diff --git a/en/includes/guides/authentication/federated-login/index.md b/en/includes/guides/authentication/federated-login/index.md index fdd44fad44..120668b799 100644 --- a/en/includes/guides/authentication/federated-login/index.md +++ b/en/includes/guides/authentication/federated-login/index.md @@ -72,6 +72,10 @@ You can register an external IdP in {{product_name}} by creating a connection. { +## Test a connection + +{% include "../../fragments/manage-connection/test-connection.md" %} + ## Configure JIT provisioning {% include "../../../guides/fragments/manage-connection/jit-provisioning.md" %} diff --git a/en/includes/guides/fragments/manage-connection/test-connection.md b/en/includes/guides/fragments/manage-connection/test-connection.md new file mode 100644 index 0000000000..4501419a95 --- /dev/null +++ b/en/includes/guides/fragments/manage-connection/test-connection.md @@ -0,0 +1,42 @@ + + +You can verify that your connection is configured correctly by running a test against the federated identity provider. {{ product_name }} initiates an authentication request to the IdP and displays the result, letting you confirm that the connection works before using it in an application's login flow. + +To test a connection: + +1. On the {{ product_name }} Console, go to **Connections**. +2. Select the **connection you want to test**. +3. Click **Test Connection** on the connection page. + + ![Test Connection button on a connection page]({{base_path}}/assets/img/guides/idp/test-connection/test-connection-button.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} + +4. {{ product_name }} redirects you to the federated identity provider's login page. Authenticate using a valid account from that IdP. +5. After a successful authentication, you are redirected back to {{ product_name }}, and the test results are displayed. + + ![Test results page showing a successful connection test]({{base_path}}/assets/img/guides/idp/test-connection/test-connection-results.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} + +The results page shows three tabs: + + + + + + + + + + + + + + + + + + +
TabDescription
ID TokenDisplays the decoded header and payload of the ID token returned by the federated IdP. Use this to verify that the token is well-formed and that expected claims such as sub, iss, and aud are present.
Claim MappingsLists the claims received from the IdP alongside the local claims they are mapped to in {{ product_name }}. Use this to confirm that claim mappings are resolving as expected.
DiagnosisProvides a step-by-step diagnostic log of the connection test. Each entry shows the stage, outcome, and any error details, making it easier to pinpoint configuration issues.
+ +!!! note + You can click **Rerun Test** at any time to run the connection test again without leaving the results page. + +If the test fails, review the **Diagnosis** tab for error details and verify the connection settings such as the client ID, client secret, and endpoint URLs.