Skip to main content Skip to complementary content

Relevant endpoints

Workspace permission endpoints

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

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

Related endpoints

Management Console API

URL: https://api.<datacenter>.cloud.talend.com/security. Replace <datacenter> with your Talend Cloud region. For more information, see Talend Cloud regions and URLs.
Endpoint Use Query parameters
GET /orchestration/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/orchestration/workspaces?query=environment.name==default

User management API

URL: https://api.<datacenter>.cloud.talend.com/
Endpoint Use Query parameters Required
GET /orchestration/users Use this endpoint to retrieve the ID of the user you want to assign permissions to on the workspace.
  • page
  • size
  • workspace_id
 Optional
Example request: 
GET https://api.us.cloud.talend.com/orchestration/users?page=1&size=50&workdpace_id=534s4400223a343495467403a

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here