Integrating CommonRoom
Capabilities
DataGrail's CommonRoom integration provides the following capabilities:
Product | Capability | ||||
---|---|---|---|---|---|
Request Manager |
|
Before You Start
To successfully configure this integration, please ensure you have sufficient privileges:
- DataGrail User Role: Super Admin, Connections Manager
- CommonRoom User Role: Admin
Create CommonRoom API Token
- Log in to CommonRoom.
- In the bottom left, select the gear icon (Settings) and then API tokens.
- Select New Token.
- In the New API Token pop-up, copy the token and store it in a secure, temporary location.
Connect to DataGrail
- Navigate back to DataGrail.
- Enter the API Token.
- Select your desired Asynchronous Deletion Behavior.
CommonRoom Deletion Behavior Configuration
Mark integration as complete when a deletion request is successfully submitted: The CommonRoom Integration will be marked as "complete" as soon as the deletion request is submitted to CommonRoom.
Continue processing until the deletion request is completed (default behavior): The CommonRoom Integration will show a "processing" status until the CommonRoom deletion is complete.
Next Steps
Now that you've successfully connected the integration, check out the following resources:
- Synchronous vs. Asynchronous Integrations
- Access Request Lifecycle
- Deletion Request Lifecycle
- Request Manager Overview
Troubleshooting
If you are unable to successfully connect the integration, review these common troubleshooting steps:
Ensure Required Permissions Are Granted on API Keys/Resources
DataGrail checks required permissions and scopes on API keys/resources used by each integration. If all necessary permissions are not granted, new connections will fail.
Review Required Account Types and User Roles
If users do not have the necessary permissions or the minimum required user role in the connecting system, the connection to DataGrail will fail. Additionally, connections will fail if your account type does not match the one required by the integration.
See Before You Start to review these requirements.
Technical Details
The CommonRoom integration uses the Common Room Core API (1.0.0):Access Type | Synchronous |
---|---|
Deletion Type | Asynchronous |
API Documentation
Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.
Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.