Setting workspace permissions for a user - 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

You can give users permissions to manage or view objects, or allow access to engines in different workspaces.

Before you begin

  • You must have Environment Administrator role in Talend Cloud Management Console.
  • You must know the IDs of the workspace and user for which your are setting the permissions.

About this task

You can access the Management Console API via https://api.us.cloud.talend.com/tmc/swagger/swagger-ui.html. You'll find a list of the URLs corresponding to each data center in Talend Cloud regions and URLs.

Procedure

  1. Use the GET /workspaces/{workspaceId}/users/{userId}/permissions endpoint to read the current permissions of the user for the selected workspace.

    Example

    GET https://api.us.cloud.talend.com/tmc/v2.4/workspaces/7a35e78eaea645620e47f826/users/d13404b5-e9nc-4g5f-9904-a5f0dc287fb0/permissions
  2. If you are assigning permissions to a user that did not have any permissions on the specified workspace, use the POST /workspaces/{workspaceId}/users/{userId}/permissions endpoint and add the permission(s) in the body of the request.

    Example

    POST https://api.us.cloud.talend.com/tmc/v2.4/workspaces/7a35e78eaea645620e47f826/users/d13404b5-e9nc-4g5f-9904-a5f0dc287fb0/permissions
    ["AUTHOR", "EXECUTE"]
  3. If you are adding a new permission to an already assigned user on the specified workspace, use the PUT /workspaces/{workspaceId}/users/{userId}/permissions endpoint and add the permission(s) in the body of the request.

    Example

    PUT https://api.us.cloud.talend.com/tmc/v2.4/workspaces/7a35e78eaea645620e47f826/users/d13404b5-e9nc-4g5f-9904-a5f0dc287fb0/permissions
    ["AUTHOR", "EXECUTE"]