> For AI agents: [llms.txt](https://docs.trustedauth.com/llms.txt) provides a Markdown index of this documentation.

# ConnectWise ScreenConnect

ConnectWise ScreenConnect is a self-hosted desktop software application that allows users to host software on their own servers (see <https://screenconnect.connectwise.com>). This integration provides instructions to integrate ConnectWise ScreenConnect with Identity as a Service. Once integrated, users can use single sign-on to log in to their ConnectWise ScreenConnect account using Identity as a Service.

note

This procedure was tested using previous versions of Identity as a Service and ConnectWise ScreenConnect. Other versions of ConnectWise ScreenConnect may require integration and configuration steps that differ from those documented in this procedure. For newer versions of ConnectWise ScreenConnect, use this procedure as a starting point for integrating ConnectWise ScreenConnect. In the event of other issues, contact <support@entrust.com> for assistance.

To integrate ConnectWise ScreenConnect with Identity as a Service, you must do the following:

## Step 1: Download the ConnectWise ScreenConnect metadata file

1. Log in to your ConnectWise ScreenConnect Administrator account.
2. Click **Admin**. The **Administration** page appears.
3. In the menu pane, click **Security**. The **Security** page appears.
4. Under **User Sources**, click **Add User Source**.
5. Select **SAML** from the drop-down list.
6. Scroll to **User Resources** and click **Add User Source**.
7. Select **SAML**. A **SAML** pane appears in the **User Source** section.
8. Click the three dots icon and select **Generate Metadata**. The **metadata** appears in a Web browser.
9. Copy and save the contents of the metadata into a text editor, such as Notepad.
10. Save the file as Connectwise_Screenconnect_SP_metadata.xml.
11. Leave this page open. You need to return to it later in this procedure.

## Step 2: Create a custom user attribute in IDaaS

1. Log in to your Identity as a Service administrator account.
2. Click Menu icon **>** **Members > Attributes**. The **User Attributes List** page appears.
3. Under **Custom User Attributes**, click **Add**. The **Add User Attribute** dialog box appears.
4. Enter **Role** for the **User Attribute Name**.
5. Check **Attribute is required**.
6. Click **Add** to create the attribute.
7. After you have created these attributes, then you need to create and map the following:
   1. Click Menu icon **>** **Resources > Directories**. The **Directories List** page appears.
   2. Select the **Directory**. The **Edit Directory** page appears.
   3. Under **Attribute Mappings**, locate the Role attribute that you just created.
   4. Click the **Role** field and enter rolename.
   5. Click **Save**.

note

rolename is a custom attribute, which needs to be created in the directory configured with IDaaS. in Directory, configured with Identity as a Service.

## Step 3: Connect the IDaaS role attribute to ConnectWise ScreenConnect

1. In ConnectWise ScreenConnect, click **Admin**. The **Administration** page appears.
2. Under **Administration**, click **Security**. The **Security** page appears.
3. Go to **Roles**, make note of the name of the role that you need to associate with IDaaS. For example, Control Host.
4. Return to your IDaaS account.
5. In IDaaS, click Menu icon **>** **Members > Users**. The **User** page appears.
6. Click a **User**, scroll to **Optional Attributes**. Confirm that the Role attribute value matches the name of the role in ConnectWise ScreenConnect, for example, Control Host.
7. Other **System User Attributes** such as **Email**, **First Name**, **Last Name** are configured by Default.

## Step 4: Add ConnectWise Screen Connect to Identity as a Service

1. Open a new Web browser window and log in to your Identity as a Service administrator account.
2. Click Menu icon **>** **Security > Applications**. The **Applications Lists** page appears.
3. Click **Add**. The **Select an Application Template** page appears.
4. Do one of the following:
   - Select **SAML Cloud Integrations** from the search drop-down list and scroll to find the application you want to add to IDaaS.
   - In the **Search bar**, enter a search option to filter for the application you want to add to IDaaS.
5. Click **ConnectWise ScreenConnect**. The **Add ConnectWise ScreenConnect** page appears.
6. Update the **Application Name** and **Application Description, as required.**
7. Optional. Add a custom application logo.
   1. Click Plus icon next to **Application Logo**. The **Upload Logo** dialog box appears.
   2. Click Upload icon to select an image file to upload.
   3. Browse to select your file and click **Open**. The **Upload Logo** dialog box reappears showing your selected image.
   4. If required, resize your image.
   5. Click **OK**.
8. Select the **Authentication Flow** that appears to users during login.
9. Click **Next**. The **General** page appears.
10. Click Upload icon to the **Upload Metadata XML** and browse to the location of the metadata file you downloaded. The **Metadata Configuration** dialog box appears.
11. If required, click **Merge with existing values** to merge new values with existing values for Alternative Assertion Consumer Services URLs and SAML attribute names.
12. Click **Save**.
13. Optional. Enter the **SAML Username Parameter Name** used to identity the user ID being requested for authentication. The user ID can then be passed as a parameter, for example, Username=jdoe.
14. Enter the **SAML Session Timeout** to the time when the SAML Assertion times out. The maximum is 720 minutes.
15. Enter the **Max Authentication Age (seconds)** to set the maximum amount of time that can elapse before a user is required to reauthenticate during a new login attempt. This applies for both SP-initiated and IDP-initiated login. Set this field to -1 to disable this feature.
16. From the **SAML NameID Attribute** drop-down list, select **Email**.
17. Select the **SAML Signing Certificate** from the drop-down list.
18. From the **SAML Response Signature Algorithm** drop-down list, select **SHA512**.
19. Optional: Select **Respond Immediately for Unsuccessful Responses** to return to the application immediately after a login failure, rather than allow user to try again with a different userID.
20. Deselect **Enable Go Back Button** if you do not want users to be able to go back to the login ConnectWise ScreenConnect page to log in.
21. Select **Show Default Assertion Consumer URL Service in the My Profile**. When selected, the Default Assertion Consumer URL appears in a user's My Profile page in addition to relay states and Alternative Assertion Consumer URLs.
22. For the IDP initiated login to be successful, you need to set up ConnectWise ScreenConnect SP-Init-SSO. ConnectWise ScreenConnect can also set up IdP-Init-SSO. IdP-Init-SSO requires IDP to send the Relay State parameter along with the SAML request. You can do this by editing the metadata xml file or setting a Relay state value. Relay states appear on the user's **My Profile** page. Do the following:
    1. Under **Relay State**, click **Add**. The **Add Relay State** dialog box appears.
    2. Enter **ConnectWise ScreenConnect** in the relay **Name** field.
    3. Enter the **Value** for the relay state. This setting specifies the application or URL that a user is redirected to after successful authentication. For example, `https://<customurl>`.screenconnect.com/Host#Access/.
    4. Select **Show in My Profile** to display the relay state on the user's My Profile page.

note

After you add relay states, you can also enable or disable them on the Add/Edit application page. Click the disable icon next to the relay state to disable it or click the enable icon to re-enable it.

23. Add SAML attributes as follows:
    1. Under **SAML Attributes**, click **Add**. The **SAML Attributes** dialog box appears.
    2. In the **Name** field enter UserID.
    3. Click **Add** next to **Value(s)**.
    4. In the **Value(s)** field, enter User ID.
    5. Repeat these steps to add the following SAML attributes and values:
       - Attribute FirstName and value First Name
       - Attribute LastName and value Last Name
       - Attribute Email and value Email
       - Attribute Role and value Role (This is the custom attribute you created in _Step 2: Create a custom role attribute_.)
    6. Click **Add** when you have finished adding all the required SAML attributes.
24. Optional. Add **Alternative Assertion Consumer Service URLs**, as follows:
    1. Click **Add**.
    2. Enter a **Name**.
    3. Enter a URL **Value**.
    4. Select **Show in My Profile** to display the Alternative Consumer Service URL in a user's My profile page.
    5. Optional. **Add an Application Logo**.
    6. Click **Add**.
    7. Repeat these steps to add more Alternative Assertion Consumer Service URLs.
25. Click **Submit**.

## Step 5: Add a resource rule

See [Create resource rules](/docs/authentication-and-security/create-and-manage-resource-rules.md).

## Step 6: Download the IDP metadata file from Identity as a Service

1. Download the Metadata file from Identity as a Service.
2. In Identity as a Service, click Menu icon **>** **Security > Applications**. The **Applications List** page appears.
3. Do one of the following:
   - Click Cloud Download icon next to the application you are integrating with Identity as a Service.
   - Click Ellipsis Vertical icon next to the application you are integrating with Identity as a Service and select **SAML IDP Metadata**.
4. The **SAML Application Metadata** dialog box appears.
5. **Select the certificate to include in the SAML IDP Metadata file** from the drop-down list.
6. If applicable, **Select the domain to include in the SAML IDP Metadata** file from the drop-down list.
7. Enter the **Lifetime, in days, for the SAML IDP Metadata file**. The value must be between 2 and 730.
8. Do one of the following, as required:
   - Copy the **Public Endpoint** to paste into your SAML application being used Identity Provider authentication.
   - Click **Download**.

note

If you are using multiple domains, you must download each domain's metadata file separately because the values in the metadata file vary for each domain.

## Step 7: Convert the IDaaS SAML IDP metadata to Base64 format

1. Go to <https://www.base64encode.org> (or a similar base64 encoding tool).
2. Set the **Destination Character Set** to **UTF-8**.
3. Paste the IDP SAML metadata your downloaded in _Step 6: Download the IDP metadata file from identity as a Service_.
4. Click **Encode**.
5. Click **Copy to Clipboard** or copy and save the contents to a text file.

## Step 8: Add the IDP metadata to ConnectWise ScreenConnect

note

UserDisplayNameAttributeKey is a required field. Without this field, the content to connect feature may not work as expected.

1. If required, log in to your ConnectWise ScreenConnect Administrator account.
2. Click **Admin**. The **Administration** page appears.
3. In the menu pane, click **Security**. The **Security** page appears.
4. In the **SAML** pane, click the three dots icon and select **Configure**. The **Edit User Source Configuration** dialog box appears.
5. In the **IdentityProviderMetadataURL** enter data:base64, and then append the metadata that you copied in _Step 5: Convert the IDaaS SAML IDP metadata to Base64 format_.

note

Do not add a space after the comma before you append the metadata.

6. Add the mapping attributes.

note

The attributes must match the name of the IDaaS SAML attribute.

7. In the **UserNameAttributeKey** field, enter FirstName.
8. In the **UserDisplayNameAttributeKey** field, enter UserID.

note

The UserDisplayNameAttributeKey can be also be either Email or LastName.

9. In the **EmailAttributeKey** field, enter Email.
10. In the **RoleNamesAttributeKey** field, enter Role.
11. Role is the custom user attribute that you created in _Step 2: Create a custom role attribute_. Ensure that the value you enter matches the IDaaS custom attribute.
12. Click **Save Configuration**.

## Step 9: Test the integration

### Testing Service Provider Login

1. Open a Web browser and enter the URL for your ConnectWise ScreenControl account. You are directed to Identity as a Service.
2. Enter your ConnectWise ScreenControl account **User ID** and click **Next**.
3. Respond to the second-factor authentication challenge. If you respond successfully, you are logged into ConnectWise ScreenControl.

### Testing Identity as a Service redirect log in

1. Log in to your Identity as a Service account.
2. Go to your **My Profile** page if you are not already there.
3. Under **Applications**, click ConnectWise ScreenControl.
4. Respond to the second-factor authentication challenge. If you respond successfully, you are logged into ConnectWise ScreenControl.