Restrict Vendor Access to Clients
Purpose
Due to compliance issues, some MSP partners need to restrict the ability for resources to see end-client machines in Automate. This solution will allow Automate admins to remove the ability to see specific clients in Automate.
NOTE: Any users with Super Admin will be able to remove the restricted access.
Content Pieces
Below are the pieces of content to make this solution function.
- Two Extra Data Fields named "Restrict Vendor Access" (One at the Client level and one at the Location level and one at computer level).
- A search that looks for machines at the clients where the EDFs are NOT marked.
- A group that is populated by the above search. This group is used to limit access to the vendor's Automate user account.
- A new userclass is also added to the system. This is to limit the permissions of users being able to check/uncheck the EDFs.
Process
-
Import the Script - ScreenConnect - Update Vendor Restricted Property* [RMM+] using the ProSync Plugin
- It is a Duplicate of the Script - ScreenConnect - Update Custom Property* [RMM+,Param], just its user parameters are global parameters.
-
Reload the System Cache
-
Run the script against any machine to create "Restrict Vendor Access" EDF's, "PropertyIndex" System Properties, "Vendor Restricted - Super Admin" user class, "Restricted vendor Access" search and "Restrict Vendor Access" group
- Navigate to Automation --> Scripts within the CWA Control Center.
- Open ScreenConnect - Update Vendor Restricted Property* [RMM+] Script
- Debug script on any machine with parameter
Set_Environment= 1
-
After performing the above step, reload the System Cache again otherwise group will cease to open with a permissions error
-
With the pieces imported this is where a super admin user must take over.
- The admin must mark the Extra Data Fields (Which are only editable if the user has the Super Admin userclass) for the clients, locations or computers that must be hidden from the Vendor. Please open the target client, location or computer and navigate to the "Info" > "Default" tab.
- The admin must mark the Extra Data Fields (Which are only editable if the user has the Super Admin userclass) for the clients, locations or computers that must be hidden from the Vendor. Please open the target client, location or computer and navigate to the "Info" > "Default" tab.
CWA User Account
-
Create the user account that you would like to restrict. The typical setup has been outlined below:
- User Account - PRONOC -
- Apply the Super Admin - Restrict Vendor Access permission to this account.
- This is the account the team is trained to use.
- Apply the Super Admin - Restrict Vendor Access permission to this account.
- User Account - PRONOCA - This is our standard US Only Super Admin account.
- When storing the credentials in ITGlue, apply the "US Resources" ITGlue Group to the password entry. This will hide it for Non-US Based resources.
- When storing the credentials in ITGlue, apply the "US Resources" ITGlue Group to the password entry. This will hide it for Non-US Based resources.
- User Account - PRONOC -
-
Assign the proper permissions to the accounts you just created
- The Vendor Restricted user should have the newly created user class assigned to it
- Vendor Restricted - Super Admin
- Vendor Restricted - Super Admin
- The US account can have the full Super Admin rights
- The Vendor Restricted user should have the newly created user class assigned to it
-
Assign the proper group membership from the Groups and Clients tab:
- For the restricted user, the only group that should be in the 'Member of' side is 'All Agents.Restrict Vendor Access'.
- This is the setting on the user account that hides the restricted clients from the login.
- This is the setting on the user account that hides the restricted clients from the login.
- For the restricted user, the only group that should be in the 'Member of' side is 'All Agents.Restrict Vendor Access'.
-
To propagate EDF changes quicker to the restricted accounts, you can force sync the search like shown below:
- Users with this configuration will perform similarly to the "All Agents" group in Automate, but thanks to the search included in the XML, excludes any clients where the EDF is marked. The 'All Agents.Restricted Vendor Access' group will not display these agents. This will effectively hide all machines at clients where the EDF is marked.
- These changes can take up to 30 minutes to go into effect. If this needs to happen more quickly, please navigate to the 'All Agents.Restricted Vendor Access' group and force update agents in the group.
Client Permissions
After following the above steps, we need to add client-level permissions for "Super Admin - Restricted Vendor Access". Follow the below steps to perform it.
-
Find the client you would like to deem the 'Default/Standard' configuration.
-
Make sure to ensure there are no exceptions to the default configuration that will need to get accounted for. Once you clear all of the permissions to begin copying the permissions, you can't view the old data.
- It is recommended to open/export the 'User Classes - Client Level Permissions Matrix [View]' dataview to allow us to re-create the permissions if asked.
-
Navigate to Automation --> Scripts within the CWA Control Center.
- Open ScreenConnect - Update Vendor Restricted Property* [RMM+] Script
- Debug script on any machine of the selected CLIENT (From step 1) with parameter
Set_Client_Permissions= 1
This will add
Super Admin - Restricted Vendor Access
UserClass with full permission to that client
-
On the client you have deemed to be the 'Default/Standard' permission structure in step 1:
- Right-click --> Permissions --> Clear All Permissions
NOTE: This will clear ALL client permissions except for the one you are selected on. If there are a lot of clients, this can lock the system up with no progress bar. Be patient and wait for the application to become responsive when hovering over things.
- Right-click --> Permissions --> Clear All Permissions
NOTE: This will clear ALL client permissions except for the one you are selected on. If there are a lot of clients, this can lock the system up with no progress bar. Be patient and wait for the application to become responsive when hovering over things.
-
Next, after the system has cleared the permissions, you should be able to tell things are not frozen by hovering over a client and seeing if it highlights as if you can click on them.
- Once it is good, right-click the same client and go to Permissions --> Copy Permissions
- Once it is good, right-click the same client and go to Permissions --> Copy Permissions
-
This will not only copy the permissions from that client everywhere, it will now become the standard default configuration for all newly created/imported clients in the future, eliminating the need to constantly update them through SQL.
ScreenConnect
-
Make sure you Duplicate the 'All Machines' group and rename the original to 'All Machines (Unrestricted)'.
-
Create "Vendor Restricted" Custom Property:
- Open the Appearance page (Admin --> Appearance)
- Type CTRL+F and look for custom property resource strings beginning with the key,
SessionProperty.Custom5.LabelText
.- Custom Property slot 1-4 are used by the CWA / CWC plugin. Avoid using them.
- Try using the properties between 5-8 that are not already used.
- Edit
SessionProperty.Custom5.LabelText
- Enter "Vendor Restricted" in the Custom text area. Click Save Resource to save
- Set the visibility of the "Vendor Restricted" Custom Field
- Just Above
SessionProperty.Custom5.LabelText
you will findSessionProperty.Custom5.AccessVisible
, Set this property to True.
- Just Above
- The final setting should look like this:
The "Vendor Restricted" property will start displaying like shown below:
Note: Use the word "Restricted" to restrict any machine in Screenconnect
-
Now go to the copied Group 'All Machines'
- Click on three dots on the right-hand side of the session group.
- Click on Edit.
- This will open a dialog box,
- Fill in the
Session Filter:
withCustomProperty5 <> 'Restricted'
So it will show only machines that are not restricted NOTE: The number after 'CustomProperty' needs to match the number configured for the solution. 5 is the most common but can be changed.
- Fill in the
-
Work with the client to set this to 'Restricted' for all machines that need to be removed from vision for vendor
-
Go to Admin --> Security --> Roles. Clone the Administrator role, rename to 'Administrator (Unrestricted)', and clone again to create a 'Administrator (Vendor Access)' or Administrator depending on the client's needs. This sets up admins or other tiered techs.
-
Last step is to apply this role and permissions on the newly restricted group:
SC Permissions
Below is the process that will ensure that when the EDFs "Restrict Vendor Access" are checked within automate, it automatically restricts the machines in SC.
-
Import the internal Monitor using ProSync Plugin
-
Import the following Alert Template using the ProSync plugin:
△ Custom - Execute Script - Update Vendor Restricted Property
-
Reload the System Cache
-
Configure the solution as follows:
- Navigate to System dashboard --> Config --> Configurations --> System Properties within the CWA Control Center.
- Fetch "Vendor Restricted" property Index From Screenconnect Portal
- In the above example we have used
SessionProperty.Custom5.LabelText
so its Property Index will be "5"- Set the Correct Value for the System property
PropertyIndex
- Set the Correct Value for the System property
- PropertyValue will automatically be fetched based on the EDF's value. If EDF's are selected and the machine is not restricted in Screenconnect it will automatically restrict it, similarly if any machine is accidentally set to restricted and EDF's are not selected at client or location level, it will automatically revert the changes for that machine.
- Navigate to Automation --> Monitors within the CWA Control Center.
- CWM - Automate - Internal Monitor - Automatically Restrict Vendor Machines in SC
- Configure with the alert template:
△ Custom - Execute Script - Update Vendor Restricted Property
- Right-click and Run Now to start the monitor.
- Configure with the alert template:
- CWM - Automate - Internal Monitor - Automatically Restrict Vendor Machines in SC
- Navigate to System dashboard --> Config --> Configurations --> System Properties within the CWA Control Center.