Fetching user IDs - Cloud

Talend Cloud APIs User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
Design and Development > Designing APIs
Design and Development > Testing APIs

Use the Talend Cloud API Tester management API to get information about the users and groups with whom you can share your test project.

About this task

In order to update the sharing settings for an API test project, you need the IDs of the users and groups that you want to share the project with.

Procedure

  1. Create a new request.
  2. In the METHOD drop-down list, select GET.
  3. Enter the following URI with the correct region parameter:
    https://apit.{region}.cloud.talend.com/api/v1/api-tests/sharings/eligibles
    The region can be:
    • us-west
    • us
    • eu
    • ap
    • au

    For more information, see Talend Cloud regions and URLs.

  4. Click the Add header button and enter Authorization in the name field and Bearer followed by a space and your token in the value field.
    Tip: In Talend Cloud API Tester, you can add your token as a private environment variable and reference it in your requests using the expression builder. For more information, see Using environments.
  5. Once your request is configured, click Send.

Results

The response returns a list of users and groups. You will need the IDs of the users and groups that you want to share the project with.