Using API to manage users, roles and groups

Using API to manage users, roles and groups - 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

You can use Talend Cloud Web API service to automate the processes to create users, assign users to groups, assign roles to users and retrieve user profiles.

The host to be used to access this API service is: https://api.<env>.cloud.talend.com
For the complete API documentation of this API service, see https://api.<env>.cloud.talend.com/v1/management/swagger-ui/?urls.primaryName=Identities%20Management.

where <env> is the name of your Cloud region. If you do not know what your region name is, see Talend Cloud regions and URLs.

Prerequisites to access this user management API:

Generate access tokens:
- For users, generate a personal access token by following Generating a Personal Access Token.
- For service accounts, generate a service access token by following Generating a service account token.
Once generated, a service account token expires after 30 minutes. If it expires, generate a new token using the POST method at the endpoint https://api.<env>.cloud.talend.com/security/oauth/token. For more information about generating a token, see Generating a service account token.