Admin Data API Overview

Resources for managing admin centric resources

Overview

Admin Data API exposes a collection of API operations to access and manage platform resources that are mutated to carry out admin centric activities without redefining data security definition.

A securable is a logical container of data that is owned by a group or principal. The owner of a securable has exclusive access to that securable and all child data. For example, the owner of an exposure set controls access to the exposures, analysis results, and variations in that exposure set.

The IRP supports five types of securables:

  • Exposure Set
  • Program Set
  • Business Hierarchy Set
  • Share Set

Entitlement

RI-DATAADMIN

Jobs

Client applications with the RI-DATAADMIN entitlement can run operations that initiate the following platform jobs:

Job TypeAPIOperation
ARCHIVE_SECURABLEAdmin Data APIArchive Securable
AUTO_DELETE_ARCHIVEAdmin Data API
COPY_TO_ARCHIVEAdmin Data APICreate Archive from Snapshot
DELETE_ARCHIVEAdmin Data APIDelete Archive
DELETE_SECURABLEAdmin Data APIDelete Securable
RESTORE_ARCHIVEAdmin Data APIRestore Archive