Using API to delete users - Cloud

Talend Cloud Management Console User Guide
Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend Management Console
Content
Administration and Monitoring > Managing projects
Administration and Monitoring > Managing users
Deployment > Deploying > Executing Pipelines
Deployment > Deploying > Executing Tasks
Deployment > Scheduling > Scheduling Tasks
Last publication date
2023-10-04
You can use the user management API to delete users.

Before you begin

Ensure that the account to be used to issue API calls has the Users - Management permissions.

About this task

In this section, Talend API Tester is used to demonstrate how to issue API calls to delete users.

Procedure

  1. Generate a personal access token for your account:
    1. In the top-right corner, click your user name.
    2. Click Profile preferences > Personal access tokens > Add token.
    3. Enter a token name and click Generate.
  2. Open Talend API Tester in your browser and select Delete from the Method list.
  3. In the field next to the Method drop-down list, enter the user management endpoint to be used: https://api.<your_environment>.cloud.talend.com/v1/management/users/<id_of_user_to_be_deleted>
    Your environment could be:
    • eu
    • us
    • us-west
  4. In the HEADERS area, click Add header and in the name field that is displayed, enter Authorization and in the value field, enterBearer and your personal access token. Enter a whitespace to separate Bearer and your personal access.
  5. Click Send to issue your call.

Results

The deletion is accomplished successfully and the status code 204 is returned.