Blog Post

Security, Compliance, and Identity Blog
1 MIN READ

Public preview: Programmatically interact with Microsoft Purview workflows using APIs and SDKs

Naga_Yenamandra's avatar
Apr 04, 2023

To increase our developer experience landscape and to allow customers to interact and extend Microsoft Purview functionality using software technologies and tools in their organization, we are happy to announce that REST APIs and SDKs for workflow data plane in public preview. Software engineers or developers in your organization can now leverage these APIs/SDKs to programmatically create or update a workflow, submit a workflow, approve or reject an action, update or re-assign an approval or task action, list or cancel workflow runs, and more.

 

In order to use any Microsoft Purview data plane APIs you need to first create a service principal and assign it to the right Microsoft Purview role before invoking the APIs. This is needed to establish trust between the service principal and the Microsoft Purview account. For example, to create a new self-service data access request workflow and bind the same to root collection, you need to provide 'Workflow Admin' role to the service principal at the root collection level. 

 

This tutorial covers details on how to create service principal, set up authentication using the service principal, get token and use the token to call Microsoft Purview data plane APIs.

 

To get started with workflow data plane APIs and SDK's please see the below links:

  • Workflow data plane APIs, see here.
  • Workflow data plane C# SDK, see here.
  • Workflow data plane Java SDK, see here.
  • Workflow data plane Python SDK, see here.
  • Workflow data plane Java script SDK, see here.
Updated Apr 04, 2023
Version 1.0
No CommentsBe the first to comment