Importing and Exporting Roles

You can export individual roles on the Roles screen to download a comprehensive list of the permissions available for the selected role. In the downloaded .csv file, you'll find every available permission, the permission description, and whether the permission is enabled or disabled for the selected role. You can also import .xlsx files to create a new custom role with the necessary permissions, if needed.

Note:

Please note the following behaviors between the role export and the Roles screen within the platform:

System roles

When exporting a system role, all available permissions will be visible in the role export regardless of if the permission is enabled or disabled for the system role. However, when accessing the system role on theRolesscreen, only permissions that are configured for the system role will be visible on the screen since system role permissions cannot be modified.

Custom roles

When exporting a custom role, all available permissions will be visible in the role export regardless of if the permission is enabled or disabled for the custom role. Similarly, when accessing the custom role on theRolesscreen, all permissions will be visible on the screen regardless of if the permission is enabled or disabled for the custom role since custom role permissions can be modified.

To export a role

  1. Click the gear icon in the upper right-hand corner to access Global Settings.
  2. On the Global Settings menu, select User management > Roles. The Roles screen appears. 


  3. Click the Context Menu icon corresponding to the role you want to export.
  4. On the Context menu, select Export. The Export role modal appears.
    Note:

    Alternatively, you can click the link in the Role name column for a given role and click the Export button on the View role details screen.

  5. Click the Close button. The Role Export file will be generated in the background. When the file is ready to download, a notification will appear on the Notifications icon .
  6. Click the Notifications icon. The Notifications popover appears.


  7. Click the link corresponding to the role you exported. A .csv file will download to your local system.


    Note:

    Customers with solution packaging subscriptions can reference the License column within the Roles list export to differentiate free versus paid entitlements, design cost‑optimized roles, and improve audit and compliance readiness.

To import a role

You can create a new custom role by exporting an existing role using the procedure above, updating the permissions on the downloaded .csv file, saving the file as a .xlsx file, and importing the file on the Roles screen. Importing a role can also be valuable in scenarios where you want to copy a custom role and all the associated permissions from one account to another.

Note:

Only standard Excel workbook (.xlsx) format is supported when importing a role. The import will fail if the file is saved in Strict Open XML Spreadsheet (.xlsx) format.

  1. Click the gear icon in the upper right-hand corner to access Global Settings.
  2. On the Global Settings menu, select User management > Roles. The Roles screen appears. 

  3. Click the Import role button. The Import role modal appears.
    Note:

    The following characters are restricted and cannot be used for role names: / ? # % & = + [ ] { } | \ ^ ` " < >



  4. Complete the fields, as necessary.
  5. In the File field, click the Upload button.
  6. Use the file explorer to select the .xlsx file you want to import.
  7. Click the Import button. The imported role will appear on the Roles screen.

To update a custom role by import

You can update the permissions of a custom role while retaining the name by selecting Replace on the Context menu for the respective role. You will be prompted to import an updated .xlsx file reflecting the latest permissions for that role.

  1. Click the gear icon in the upper right-hand corner to access Global Settings.
  2. On the Global Settings menu, select User Management > Roles. The Roles screen appears. 

  3. Click the Context Menu icon for the custom role you want to update.
  4. On the Context menu, select Replace. The Replace Role modal appears.


  5. Click the Upload button.
  6. Use the file explorer to select the .xlsx file you want to import.
  7. Click the Replace button.