Authenticating to Talend Data Stewardship REST API - 8.0

Talend Data Stewardship User Guide

Version
8.0
Language
English
Product
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
Module
Talend Data Stewardship
Content
Administration and Monitoring > Managing users
Data Governance > Assigning tasks
Data Governance > Managing campaigns
Data Governance > Managing data models
Data Quality and Preparation > Handling tasks
Data Quality and Preparation > Managing semantic types
Last publication date
2024-02-22
Sometimes you may want to access Talend Data Stewardship REST API and perform a set of actions such as tracking the audit events or listing specific campaigns. To do so you need to implement an API authentication and authorization method.

Before you begin

You have installed and launched all Talend Data Stewardship modules.

Procedure

  1. Open a terminal and execute a POST request to call a login API.
    This API provides an authentication token in the authorization response header.

    Below is a sample login POST request and response.

    Example

    curl -v -X POST '<TDS_URL>/data-stewardship/login?client-app=STUDIO' -F username=<USERNAME> -F password=<PASSWORD>
    > POST /data-stewardship/login?client-app=STUDIO HTTP/1.1
    > Host: <TDS-HOST>
    > User-Agent: curl/7.47.0
    > Accept: */*
    ...
    < access-control-expose-headers: authorization
    < authorization: Bearer eyJraWQiOiJpYW0tb2lkYy1jbG91ZCIsImQu2WembcCA
    ...
    
  2. In Talend Data Stewardship API calls, enter the authentication token value in the Authorization header.
    Below is a sample request and response to list campaigns owned by a specific campaign owner.

    Example

    curl -X GET 'https://<TDS-HOST>/data-stewardship/api/v1/campaigns/owned'
     -H 'Authorization: Bearer eyJraWQiOiJpYW0tb2lkYy1jbG91ZCIsImQu2WembcCA'
    Response:
    []