Redivis Documentation
API DocumentationRedivis Home
  • Introduction
  • Redivis for open science
    • FAIR data practices
    • Open access
    • Data repository characteristics
    • Data retention policy
    • Citations
  • Guides
    • Getting started
    • Discover & access data
      • Discover datasets
      • Apply to access restricted data
      • Create a study
    • Analyze data in a workflow
      • Reshape data in transforms
      • Work with data in notebooks
      • Running ML workloads
      • Example workflows
        • Analyzing large tabular data
        • Create an image classification model
        • Fine tuning a Large Language Model (LLM)
        • No-code visualization
        • Continuous enrollment
        • Select first/last encounter
    • Export & publish your work
      • Export to other environments
      • Build your own site with Observable
    • Create & manage datasets
      • Create and populate a dataset
      • Upload tabular data as tables
      • Upload unstructured data as files
      • Cleaning tabular data
    • Administer an organization
      • Configure access systems
      • Grant access to data
      • Generate a report
      • Example tasks
        • Emailing subsets of members
    • Video guides
  • Reference
    • Your account
      • Creating an account
      • Managing logins
      • Single Sign-On (SSO)
      • Workspace
      • Studies
      • Compute credits and billing
    • Datasets
      • Documentation
      • Tables
      • Variables
      • Files
      • Creating & editing datasets
      • Uploading data
        • Tabular data
        • Geospatial data
        • Unstructured data
        • Metadata
        • Data sources
        • Programmatic uploads
      • Version control
      • Sampling
      • Exporting data
        • Download
        • Programmatic
        • Google Data Studio
        • Google Cloud Storage
        • Google BigQuery
        • Embedding tables
    • Workflows
      • Workflow concepts
      • Documentation
      • Data sources
      • Tables
      • Transforms
        • Transform concepts
        • Step: Aggregate
        • Step: Create variables
        • Step: Filter
        • Step: Join
        • Step: Limit
        • Step: Stack
        • Step: Order
        • Step: Pivot
        • Step: Rename
        • Step: Retype
        • Step: SQL query
        • Variable selection
        • Value lists
        • Optimization and errors
        • Variable creation methods
          • Common elements
          • Aggregate
          • Case (if/else)
          • Date
          • DateTime
          • Geography
          • JSON
          • Math
          • Navigation
          • Numbering
          • Other
          • Statistical
          • String
          • Time
      • Notebooks
        • Notebook concepts
        • Compute resources
        • Python notebooks
        • R notebooks
        • Stata notebooks
        • SAS notebooks
        • Using the Jupyter interface
      • Access and privacy
    • Data access
      • Access levels
      • Configuring access
      • Requesting access
      • Approving access
      • Usage rules
      • Data access in workflows
    • Organizations
      • Administrator panel
      • Members
      • Studies
      • Workflows
      • Datasets
      • Permission groups
      • Requirements
      • Reports
      • Logs
      • Billing
      • Settings and branding
        • Account
        • Public profile
        • Membership
        • Export environments
        • Advanced: DOI configuration
        • Advanced: Stata & SAS setup
        • Advanced: Data storage locations
        • Advanced: Data egress configuration
    • Institutions
      • Administrator panel
      • Organizations
      • Members
      • Datasets
      • Reports
      • Settings and branding
    • Quotas and limits
    • Glossary
  • Additional Resources
    • Events and press
    • API documentation
    • Redivis Labs
    • Office hours
    • Contact us
    • More information
      • Product updates
      • Roadmap
      • System status
      • Security
      • Feature requests
      • Report a bug
Powered by GitBook
On this page
  • Overview
  • Data exports
  • Export environments
  • Configuring export restrictions
  • Requesting export approval
  • Export approval

Was this helpful?

Export as PDF
  1. Reference
  2. Data access

Usage rules

Last updated 5 months ago

Was this helpful?

Overview

For high-risk data, it is often important that full data are never downloaded to a non-sandbox environment. To handle this use case, Redivis implements the concept of usage rules. Usage rules define what actions a research can take with a dataset once they have data access.

Usage rules can be applied to any organization-owned dataset, either as part of the dataset's or on a . We currently support restrictions on data exports, which are visible to any user applying for access, and will also be shown in the .

If a table is derived from multiple datasets, the export restrictions on that table will represent the intersection of the configuration of restrictions from each dataset.

Data exports

These restrictions apply to all users of a dataset (expect organization administrators, who may bypass the restrictions to export data).

Export environments

Export of restricted data on Redivis is allowed through export environments. Each environment defines a location or locations to which a user can export data under certain conditions.

Export environments can limit data exports to specific IP addresses, Google Cloud Storage buckets, Google BigQuery projects, or to Google Data Studio.

In addition, organization admins can specify either size limitations (by number of table rows or table gigabytes), or require that every export receives admin approval. If you tries to export a table larger than the size limitation, they have to get admin approval.

IP address

IP address environments limit downloads to only a specific IP address (or a set of addresses) configured by the organization admin.

Google BigQuery

BigQuery environments limit exports to only a specific Google BigQuery project (or set of projects) configured by the organization admin.

Google Cloud Storage

Cloud Storage environments limit exports to only a Google Cloud Storage bucket (or set of buckets) specified by the organization admin.

Google Data Studio

Data Studio environments limit exports to only Google Data Studio.

Custom location

Custom environments limit exports to any user-requested location (either an IP address, BigQuery project, Cloud Storage bucket, or Data Studio), but must always receive admin approval for each user-specified location.

Configuring export restrictions

Requesting export approval

Depending on the configuration of export environments on a dataset with restricted exports, you may have to request admin approval to export data.

If the button (Download, Visualize data, or Export) in the table export modal) to your desired export destination is disabled, you should Request approval from organization admins. Approvals apply only to individual tables — you cannot request blanket exceptions to a dataset.

Export approval

All data export restrictions apply to interactions through the web UI as well as through . They can be configured as to whether they allow researchers to .

You can define export environments used by your organization when configuring access to a dataset or permission group, or in the .

Configuring export restrictions is only available to organization-owned datasets. Export environments can be added to a dataset through the or standardized across datasets through a .

This workflow is similar to , and an administrator will be alerted to your request, which they can either approve or reject.

When a member of an organization submits an export exception request, it will show up as an , directing you to the Export approvals tab. If you open the approval request, you will see details about the table that is being requested, alongside the ability to view that table in the context of the researchers' workflow. The request can be approved or rejected .

organization's settings
access configuration interface,
permission group
access configuration
permission group
table export interface
request exceptions
API calls
requesting requirement approval
alert for that member
much the same way as requirements