Relevant endpoints - 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

Workspace permission endpoints

Managing workspace permissions requires the use of the following Management Console API endpoints:

Path Method Description Query parameters Required
/permissions GET Retrieve all workspace permissions according to search criteria userId Optional
workspaceID Optional
environmentID Optional
/permissions/batch POST Create sets of workspace permissions for a list of users - -
PUT Update sets of workspace permissions for a list of users - -
DELETE Delete sets of workspace permissions for a list of users - -
/workspaces/{workspaceId}/users/{userId}/permissions GET Retrieve the specified user's permissions in the specified workspace - -
POST Assign permissions to the specified user in the specified workspace - -
PUT Replace the specified user's permissions in the specified workspace with the ones provided in the body of the request - -
DELETE Remove all permissions of the specified user in the specified workspace - -

Related endpoints

Management Console API

URL: https://api.<datacenter>.cloud.talend.com/tmc/swagger/swagger-ui.html#/ 1
Endpoint Use Query parameters
GET /workspaces Use this endpoint to retrieve the ID of the workspace for which you want to set permissions. query (FIQL format)

Example: "name==TestWorkspace","environment.name==TestEnvironment"

Example request:
GET https://api.us.cloud.talend.com/tmc/v2.4/workspaces?query=environment.name==default

User management API

URL: https://api.<datacenter>.cloud.talend.com/v1/management/swagger-ui.html
Endpoint Use Query parameters Required
GET /v1/management/users Use this endpoint to retrieve the ID of the user you want to assign permissions to on the workspace. page Optional
size Optional
workspace_id Optional
Example request:
GET https://api.us.cloud.talend.com/v1/management/users?page=1&size=50&workdpace_id=534s4400223a343495467403a
1 Replace <datacenter> with your Talend Cloud region. For more information, see Talend Cloud regions and URLs .