TMC\_CLUSTER\_MANAGEMENT TMC\_ENVIRONMENT\_MANAGEMENT TMC\_GROUP\_MANAGEMENT TMC\_OPERATOR TMC\_ROLE\_MANAGEMENT TMC\_USER\_MANAGEMENT

71 actions

Action

Description

Required scopes

List Environments

Retrieve all environments configured in Talend Cloud with optional FIQL filtering via GET /orchestration/environments.

Create Environment

Create a new environment with an initial workspace via POST /orchestration/environments.

Delete Environment

Permanently remove an empty environment via DELETE /orchestration/environments/\{environmentId} (the environment must be...

Update Environment

Update the name, description, or cloud container limit of an environment via PUT /orchestration/environments/\{environmen...

List Connections

Retrieve all connections with optional filtering by environment, workspace, or name via GET /orchestration/connections.

Get Connection

Retrieve full details of a specific connection via GET /orchestration/connections/\{connectionId}.

Create Connection

Create a new reusable connection with credentials and configuration via POST /orchestration/connections.

Update Connection

Modify the name or configuration parameters of an existing connection via PUT /orchestration/connections/\{connectionId}.

Delete Connection

Permanently remove a connection and its stored credentials via DELETE /orchestration/connections/\{connectionId}.

Move Connection

Move a connection to a different workspace within the same environment via PUT /orchestration/connections/\{connectionId}...

List Groups

Retrieve all user groups with optional name filtering and pagination via GET /account/groups.

Get Group

Retrieve detailed information about a specific user group via GET /account/groups/\{id}.

Create Group

Create a new user group for organizing users and managing permissions collectively via POST /account/groups.

Update Group

Rename an existing user group via a partial PATCH /account/groups/\{id} update.

Delete Group

Permanently remove a user group from the account via DELETE /account/groups/\{id}.

List Group Users

Retrieve all users belonging to a specific group via GET /account/groups/\{id}/users with pagination.

Add Users To Group

Add one or more users to a group via POST /account/groups/\{id}/users, granting group-level permissions immediately.

Remove User From Group

Remove a specific user from a group via DELETE /account/groups/\{id}/users/\{userId}, revoking group-level permissions.

Get Unified Credentials

Get the current Talend Cloud connection's unified credentials and identity.

List Unified Groups

List unified groups in Talend Cloud.

Get Unified Group

Get a unified Talend Cloud group by ID.

List Unified Organizations

List unified organizations in Talend Cloud.

Get Unified Organization

Get a unified Talend Cloud organization by ID.

List Unified Resource Types

List unified resource types in Talend Cloud.

List Unified Resource Users

List unified resource users in Talend Cloud.

List Unified Roles

List unified roles in Talend Cloud.

Get Unified Role

Get a unified Talend Cloud role by ID.

List Unified Users

List unified users in Talend Cloud.

Get Unified User

Get a unified Talend Cloud user by ID.

List Remote Engines

Retrieve all remote engines registered in the account with optional FIQL filtering via GET /processing/runtimes/remote-e...

Get Remote Engine

Retrieve detailed information about a specific remote engine via GET /processing/runtimes/remote-engines/\{id}.

List Remote Engine Clusters

Retrieve all remote engine clusters for high-availability and load balancing via GET /processing/runtimes/remote-engine-...

Get Remote Engine Cluster

Retrieve detailed information about a specific remote engine cluster via GET /processing/runtimes/remote-engine-clusters...

Get Current User

Retrieve profile information about the currently authenticated user or service account via GET /account/me.

Create Remote Engine

Register a new remote engine in an environment for on-premises job execution via POST /processing/runtimes/remote-engine...

List Schedules

Retrieve all schedules with filtering by environment, description, and binding status via GET /orchestration/schedules.

Get Schedule

Retrieve complete details of a schedule including all triggers and binding status via GET /orchestration/schedules/\{sche...

Create Schedule

Create a new orphan schedule with an initial trigger in a specified environment via POST /orchestration/schedules.

Update Schedule Description

Update the functional description of a schedule via PATCH /orchestration/schedules/\{scheduleId} without modifying trigge...

Clone Schedule

Duplicate a schedule with all its triggers into a new orphan schedule via POST /orchestration/schedules/\{scheduleId}.

Delete Schedule

Delete an orphan schedule via DELETE /orchestration/schedules/\{scheduleId} (only unbound schedules can be deleted).

Add Schedule Trigger

Add a new trigger to an existing schedule via POST /orchestration/schedules/\{scheduleId}/triggers (max 15 per schedule).

Update Schedule Trigger

Update an existing trigger's configuration within a schedule via PUT /orchestration/schedules/\{scheduleId}/triggers.

Remove Schedule Trigger

Remove a specific trigger from a schedule via DELETE /orchestration/schedules/\{scheduleId}/triggers by trigger name.

Simulate Schedule Events

Preview upcoming triggered events for a schedule within a time range via GET /orchestration/schedules/\{scheduleId}/event...

List Plan Executions

Retrieve plan execution history with filtering by time range, status, environment, and workspace via GET /processing/exe...

List Tasks

Retrieve all available tasks with filtering by environment, runtime, workspace, and artifact via GET /orchestration/exec...

Create Task

Create a new executable task in a workspace with artifact binding via POST /orchestration/executables/tasks.

List Plans

Retrieve all available plans with filtering by environment, workspace, task, and plan ID via GET /orchestration/executab...

Create Plan

Create a new multi-step plan to orchestrate task workflows via POST /orchestration/executables/plans.

List Artifacts

Retrieve all available artifacts with filtering by environment, workspace, name, and type via GET /orchestration/artifac...

List Users

Retrieve a paginated list of all users with profile details and role assignments via GET /account/users.

Get User

Retrieve the full profile, access details, and role assignments for a specific user via GET /account/users/\{id}.

Create User

Create a new user account with profile details and optional invitation email via POST /account/users.

Update User

Update an existing user's profile via a full replacement PUT /account/users/\{id} request.

Delete User

Permanently delete a user account and revoke all access immediately via DELETE /account/users/\{id}.

Assign Roles To User

Assign one or more roles to a user via POST /account/users/\{id}/roles, granting all associated permissions immediately.

List User Roles

Retrieve all roles directly assigned to a specific user via GET /account/users/\{id}/roles with pagination.

Revoke Role From User

Remove a specific role from a user via DELETE /account/users/\{id}/roles/\{roleId}, revoking associated permissions.

List Roles

Retrieve all available roles with optional name filtering and pagination via GET /account/roles.

Get Role

Retrieve the full definition of a specific role including all permission identifiers via GET /account/roles/\{id}.

Create Role

Create a new custom role with a name and required permission assignments via POST /account/roles.

Update Role

Update an existing custom role's name or permissions via full replacement PUT /account/roles/\{id}.

Delete Role

Permanently delete a custom role and unassign it from all users via DELETE /account/roles/\{id}.

Assign Role To Users

Bulk assign a role to multiple users in a single POST /account/roles/\{id}/users operation.

List Role Users

Retrieve all users assigned a specific role via GET /account/roles/\{id}/users with pagination.

Remove User From Role

Remove a specific user from a role via DELETE /account/roles/\{id}/users/\{userId}, revoking the role's permissions.

List Workspaces

Retrieve all workspaces with optional FIQL query filtering via GET /orchestration/workspaces.

Create Workspace

Create a new Custom workspace within an environment via POST /orchestration/workspaces.

Update Workspace

Modify configuration of an existing workspace via PUT /orchestration/workspaces/\{id} including name, owner, and artifact...

Delete Workspace

Permanently remove a Custom workspace and cascade delete all contents via DELETE /orchestration/workspaces/\{id}.

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.