Skip to main content

What permissions does my Rock RMS REST key need?

Tim McHugh avatar
Written by Tim McHugh
Updated yesterday

To use Clearstream's Rock RMS integration, create a REST Key in Rock that has full access to your Rock RMS installation. To do this, simply assign the REST Key the "RSR - Rock Administration" Security Role.

What if I want more control over what the REST key can access?

To have more granular control of the permissions your REST key has, assign it a new security role with the permissions below.

  1. Create a new Security Role in Settings > Security > Security Roles.
    ​

  2. Navigate to Settings > Security > REST Controllers. For each Rest Controller below, click the lock icon and add the required permissions for the newly created security roles.

3. Create a new REST key and assign it the new security role.

Rest Controller

Permissions

Reason

Attributes

View

For getting Workflow Attributes to show in the "Push to Rock" step.

Campuses

View

To pull in rock campuses for branching and filtering.

DataViews

View

For syncing Data Views into Clearstream.

DefinedValues

View

To get the ID of certain fields (e.g. Person Phone Type Mobile and Person Record Status Active).

Groups

View

For syncing groups into Clearstream and listing groups in the Push to Rock step.

GroupMembers

View, Edit

For getting the people in a group when syncing groups.

People

View, Edit

For Creating and Updating People. For getting the name of the API Token Person. For launching workflows on a person.

PhoneNumbers

Edit

For creating Phone Numbers of new People when pushing subscribers to Rock.

WorkflowTypes

View

For presenting a list of workflows in the "Push to Rock" step.

Did this answer your question?