Revision as of 15:07, 2 March 2022

Follow along with me! Nothing scary here!

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.

Start Building

Getting Started with the BigID API

Learn how to Authenticate with the BigID API

Executing DSARs via API

Run a DSAR on a user by email address

Add Data Sources via API

Add a database from an external inventory system

@@ Line 1: / Line 1: @@
-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.
+<html>
+<style>
+.head {
+    max-width:600px;
+    width:40vw;
+}
+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>Follow along with me! Nothing scary here!</h1>
+<p>Learn how to use BigID programmatically through a series of tutorials going through commonly automated tasks.</p>
+</div>
+<img class="head" src="/cdn/api.svg"/>
+</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.
+==Start Building==
+{{Featured|Getting Started with the BigID API|Learn how to Authenticate with the BigID API|/wiki/BigID_API/Tutorial}}
-{{Warning|Accessing the BigID Docs site requires a user account. You can request a user account by emailing [mailto:[email protected] support]}}
+{{Featured|Executing DSARs via API|Run a DSAR on a user by email address|/wiki/BigID_API/DSAR_Tutorial}}
+{{Featured|Add Data Sources via API|Add a database from an external inventory system|/wiki/BigID API/Add Data Source Tutorial}}
-* Documentation for the BigID API is available on the BigID Docs site at https://www.docs.bigid.com/bigid/reference/api-getting-started.
-* Interfacing with BigID APIs is taught in the BigID Specialist Expert Class. You can register for that class at https://mybigid.com/register
-* {{Category:API}}