diff --git a/docs/img/settings_identity_chart.png b/docs/img/settings_identity_chart.png new file mode 100644 index 00000000..c76d0c12 Binary files /dev/null and b/docs/img/settings_identity_chart.png differ diff --git a/docs/webapp/webapp_profile.md b/docs/webapp/webapp_profile.md index 85b63025..6f404a21 100644 --- a/docs/webapp/webapp_profile.md +++ b/docs/webapp/webapp_profile.md @@ -347,8 +347,9 @@ on the respective column and select the users / groups to view from the list tha This feature is available under the ClearML Enterprise plan ::: -Administrators can connect identity service providers to the server. Once an identity provider connection is configured and enabled, -the option appears in your server login page. +Administrators can connect identity service providers to the server: configure an identity connection, which allows +ClearML to communicate with your identity provider, retrieve user information, authenticate users, and more. Once an identity +provider connection is configured and enabled, the option appears in your server login page. **To create a new connection**: 1. Click **+ New Connection** @@ -370,7 +371,9 @@ the option appears in your server login page. * Microsoft AD * Custom 3. Click **Next** -4. Provide the **Provider Connection Configuration**: +4. Provide the **Provider Connection Configuration**. Note that some of the information, such as the `Client ID`, + `Client Secret`, and the `Authorization Endpoint`, must be obtained from your identity provider's ClearML App settings + and copied to the relevant field. @@ -482,6 +485,8 @@ The **Provider Connections** table lists all currently defined connections, and Hover over a connection in the table to **Edit** or **Delete** it. +![Identity provider chart](../img/settings_identity_chart.png) + ## Usage & Billing The **USAGE & BILLING** section displays your ClearML workspace usage information including: