Using API service to manage users, roles and groups - Cloud

Talend Cloud APIs User Guide

EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
task
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:

User management endpoints

Operations Methods Resources Required permissions
Retrieving all users under your tenant GET

/v1/management/users

Users - Management
Creating one user per request. POST

/v1/management/users

Users - Management
Retrieving a specific user GET /v1/management/users/<userId> Users - Management
Updating details of a specific user PUT /v1/management/users/<userId> Users - Management
Deleting a specific user DELETE /v1/management/users/<userId> Users - Management
Listing the groups to which a specific user belongs GET /v1/management/users/<userId>/groups Users - Management
Adding a specific user to the specified groups POST /v1/management/users/<userId>/groups Users - Management
Removing a given user from a specific group DELETE

/v1/management/users/<userId>/groups/<groupId>

Users - Management
Listing the roles assigned to a specific user GET /v1/management/users/<userId>/roles Users - Management
Assigning roles to a specific user POST /v1/management/users/<userId>/roles Users - Management
Revoking a role from a specific user DELETE /v1/management/users/<userId>/roles/<roleId> Users - Management

Group management endpoints

Operations Methods Resources Required permissions
Retrieving specified groups GET

/v1/management/groups

Groups - Management
Creating one group per request POST

/v1/management/groups

Groups - Management
Retrieving details of a specific group GET /v1/management/groups/<groupId> Groups - Management
Deleting a specific group DELETE /v1/management/groups/<groupId> Groups - Management
Renaming a specific group PATCH /v1/management/groups/<groupId> Groups - Management
Retrieving users belonging to a specific group GET /v1/management/groups/<groupId>/users Groups - Management
Adding users to a specified group if an user is not already in this group POST

/v1/management/groups/<groupId>/users

Users - Management
Deleting a given user from a specific group DELETE /v1/management/groups/<groupId>/users/<userId> Users - Management

Role management endpoints

Operations Methods Resources Required permissions
Retrieving specified roles GET

/v1/management/roles

Roles - Management
Creating one role per request POST

/v1/management/roles

Roles - Management
Retrieving a role by its Id GET /v1/management/roles/<roleId> Roles - Management
Updating a specific role PUT /v1/management/roles/<roleId> Roles - Management
Deleting a specific role DELETE /v1/management/roles/<roleId> Roles - Management
Retrieving the users to which a specific role has been assigned GET

/v1/management/roles/<roleId>/users

Roles - Management
Assigning a specific role to users POST

/v1/management/roles/<roleId>/users

Users - Management
Revoking a role from a specific user DELETE /v1/management/roles/<roleId>/users/<userId> Users - Management