Latest revision as of 13:44, 3 April 2022

Lets get started!

Learn how to use BigID programmatically through a series of tutorials going through commonly automated tasks.

About the API

BigID was designed as an open platform. Any action that can be performed in our UI can also be done programatically. This allows you to connect anything and everything to the data discovery capabilities of your BigID system. No matter your affiliation (or lack thereof) with BigID, the API is here and open for you to use.

Before developing, be sure to see our best practice guide to get started on the right path.

Configure BigID

Getting Started with the BigID API

Learn how to Authenticate with the BigID API

Add Data Sources via API

Add a database from an external inventory system

Scan Data in Motion

Scan streaming data from systems like Kinesis and Kafka

Run Common Tasks

Executing DSARs via API

Run a DSAR on a user by email address

Find Duplicate Data

Use the catalog to find duplicate data across your systems

Scan Raw Data

Scan data without adding it as a data source

Synchronize Systems

Get Object Metadata

Discover classifications, file permissions and attributes to send to an external system.

Looking for more? Visit the API Docs

@@ Line 1: / Line 1: @@
-== BigID API ==
+<html>
-The BigID API allows you to do anything you can do through the BigID UI programmatically. That could be adding data sources, running DSAR requests from an external privacy portal, or even extracting insights to a data science tool like Tableau or R Studio.
+<style>
+.head {
+    max-width:600px;
+    height:30vh;
+}
+header {
+    display: flex;
+}
+.page-heading {
+display: none;
+}
+@media only screen and (max-width: 600px) {
+  header {
+    flex-direction: column-reverse;
+  }
+  .head { width:100%; max-width:100%;}
+}
+</style>
+<header>
+<div>
+<h1>Lets get started!</h1>
+<p>Learn how to use BigID programmatically through a series of tutorials going through commonly automated tasks.</p>
+</div></header>
+</html>
+==About the API==
+BigID was designed as an open platform. Any action that can be performed in our UI can also be done programatically. This allows you to connect anything and everything to the data discovery capabilities of your BigID system. No matter your affiliation (or lack thereof) with BigID, the API is here and open for you to use.
-The most common use case for the BigID API is to automate repetitive tasks, like loading data sources.
+{{Note|Before developing, be sure to see <strong>[[:BigID_API/Best Practices|our best practice guide]]</strong> to get started on the right path.}}
-{{Warning|Accessing the BigID Docs site requires a user account. You can request a user account by emailing [mailto:[email protected] support]}}
+==Configure BigID==
+{{Featured|Getting Started with the BigID API|Learn how to Authenticate with the BigID API|/wiki/BigID_API/Tutorial}}
+{{Featured|Add Data Sources via API|Add a database from an external inventory system|/wiki/BigID API/Add Data Source Tutorial}}
+{{Featured|Scan Data in Motion|Scan streaming data from systems like Kinesis and Kafka|/wiki/BigID API/Scan Data In Motion Tutorial}}
-* Documentation for the BigID API is available on the BigID Docs site at https://www.docs.bigid.com/bigid/reference/api-getting-started.
+== Run Common Tasks==
+{{Featured|Executing DSARs via API|Run a DSAR on a user by email address|/wiki/BigID_API/DSAR_Tutorial}}
+{{Featured|Find Duplicate Data|Use the catalog to find duplicate data across your systems|/wiki/BigID_API/Duplicate_Data_Tutorial}}
+{{Featured|Scan Raw Data|Scan data without adding it as a data source|/wiki/BigID_API/Scan_Payload_Tutorial}}
-* Interfacing with BigID APIs is taught in the BigID Specialist Expert Class. You can register for that class at https://mybigid.com/register
+== Synchronize Systems ==
+{{Featured|Get Object Metadata|Discover classifications, file permissions and attributes to send to an external system. |/wiki/BigID_API/Metadata_Export_Tutorial}}
+<html>
+<style>
+.wantmore{
+  font-size: 1em;
+  text-align: center;
+  padding: 2vh 0px;
+  border: 1px solid rgba(255,255,255,.1);
+  border-left: 0px;
+  border-right: 0px;
+}
+</style>
+<div class="wantmore">
+Looking for more? Visit the <a href="https://api.bigid.com/">API Docs</a>
+</div>
+</html>

BigID API: Difference between revisions