Updating users' permissions on multiple workspaces - 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

The workspaces may belong to different environments.

Before you begin

  • You must have Environment Administrator role in Talend Cloud Management Console.
  • You must know the IDs of the workspaces and users 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 endpoint to retrieve the IDs of the appropriate workspaces.
    You can narrow the search to a single environment by using the query=environment.name=={environmentName} query parameter.

    Example

    GET https://api.us.cloud.talend.com/tmc/v2.4/workspaces?query=environment.name==default
  2. Copy the appropriate workspace IDs from the response body.
  3. In the User Management API, use the GET /management/users endpoint to retrieve the user IDs.
    You can narrow the search to a single environment or workspace by using the environment_id or workspace_id query parameters.

    Example

    GET https://api.us.cloud.talend.com/v1/management/users?environment_id=5f2a756784fe57eeb4a3f1a
  4. Copy the appropriate user IDs from the response body.
  5. Use the POST (if the workspace is new) or PUT (if the workspace already has permissions) /permissions/batch endpoint to assign permissions to the users of the workspace.
    Paste the copied information to the body of the request (workspace and user IDs).

    Example

    POST https://api.us.cloud.talend.com/tmc/v2.4/permissions/batch
    [
        {
         "workspaceId": "5c9212a48c320343cbb5fc4b",
    "userId": "e8f79686-821b-491e-b796-86821b491eb2",
            "permissions": [
                "AUTHOR",
                "EXECUTE",
                "MANAGE",
                "PUBLISH",
                "VIEW"
            ]
        },
        {
              "workspaceId": "9d9212a67c320343chh5fc7l",
          "userId": "e8f79686-821b-491e-b796-86821b491eb2",
            "permissions": [
                "EXECUTE",
                "AUTHOR",
                "VIEW"
            ]
        },
        {
             "workspaceId": "9d9212a67c320343chh5fc7l",
          "userId": "3b7f0e11-4e93-4587-95b2-1ae6292fbb5b",
            "permissions": [
                "EXECUTE",
                "VIEW"
            ]
        }
    ]
  6. To validate that permissions are set correctly, use the GET /permissions endpoint with the workspaceID query parameter for each workspace.
    If the modified workspaces belong to the same environment, you can use the environmentID parameter to retrieve all workspaces and their permission at the same time.

    Example

    GET https://api.us.cloud.talend.com/tmc/v2.4/permissions?workspaceId=9d9212a67c320343chh5fc7l