HomeGuidesAPI ReferenceChangelog
Guides

Bulk Set Permissions

The RegScale set_permissions CLI allows bulk setting of record-level permissions in RegScale. It supports the following commands:

new: This function will create a local Excel spreadsheet for users to edit to be able to bulk create new records.

regscale set_permissions new --path <path to where to export files>

load: This function sets the permissions contained in the edited spreadsheet

regscale set_permissions load --file <file name containing the permissions records>

Usage

To use the feature, run new to generate the spreadsheet. Edit the spreadsheet to add the following information (add a line per permission):

regscale_idregscale_modulepublic / privategroup_idpermission
The id of the record in RegScaleThe RegScale Module:
e.g. securityplans, supplychain, components, etc.
Set the record to public or privateThe id of the group to add accessesR = Read Only
RU = Read and Update/Write

Once the spreadsheet is built, run load and it will apply the permissions to the records according to the lines in the spreadsheet.