Authenticate to Data Catalog service (Azure Data Catalog REST API)

The Data Catalog REST API is a REST-based API that provides programmatic access to Data Catalog resources to register, annotate, and search data assets programmatically.

Introduction to authentication in Data Catalog

Data Catalog apps are integrated with Azure Active Directory (Azure AD) to provide secure sign-in and authorization for your app. To integrate a Data Catalog app with Azure AD, you register the details about your application with Azure AD by using the Azure portal. When you register an app in Azure Active Directory, the application outsources authentication to Azure AD. App registration involves telling Azure AD about your application including the URL where it is located, the URL to send replies after authentication, and the URI to identify your application. When you register a client app or web app in Azure AD, you give your app access to the Data Catalog REST API.

A Data Catalog app uses a Client ID to identify itself to Azure AD. See Azure app client ID.

To learn how to register and authenticate a Data Catalog app:

  • Data Catalog client app: See Register a client app and Authenticate a Data Catalog client app.

  • To learn how to use Azure authentication on different platforms: The Azure Authentication Libraries are available on different platforms to help developers easily authenticate users to cloud or o-premises Active Directory (AD) to obtain access tokens for securing API calls. This topic contains a roadmap to the authentication libraries available on different platforms and to helpful resources for each, including source code and samples.

Azure app client ID

An Azure app has a Client ID that is used by the application to identify themselves to the users that they are requesting permissions from. You use a Client ID to get an authentication token. To get an Azure Client ID, see How to get a client app ID.

For a complete sample of how to use an Azure Client ID to authenticate a client app, see Authenticate a client app.