BigID API: Difference between revisions

From BigID Developer Portal
No edit summary
 
(17 intermediate revisions by the same user not shown)
Line 26: Line 26:
==About the API==
==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.
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.
{{Note|Before developing, be sure to see <strong>[[:BigID_API/Best Practices|our best practice guide]]</strong> to get started on the right path.}}


==Configure BigID==
==Configure BigID==
{{Featured|Getting Started with the BigID API|Learn how to Authenticate with the BigID API|/wiki/BigID_API/Tutorial}}
{{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|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}}


== Run Common Tasks==
== Run Common Tasks==
{{Featured|Executing DSARs via API|Run a DSAR on a user by email address|/wiki/BigID_API/DSAR_Tutorial}}
{{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|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}}


== Synchronize Systems ==
== Synchronize Systems ==
{{Featured|Get Object Metadata|Discover classifications, file permissions and attributes to send to an external system. |/wiki/BigID_API/Metadata_Export_Tutorial}}
{{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>

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

Run Common Tasks

Synchronize Systems

Looking for more? Visit the API Docs