Utiliser une API pour créer un·e utilisateur·trice - Cloud

Guide d'utilisation des API Talend Cloud

Version
Cloud
Language
Français (France)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
Création et développement > Création d'APIs
Création et développement > Test d'API
Vous pouvez utiliser l'API de gestion des utilisateur·trices pour créer des utilisateur·trices.

Avant de commencer

Assurez-vous que le compte à utiliser pour émettre des appels d'API a l'autorisation Users - Management.

Pourquoi et quand exécuter cette tâche

Dans cette section, Talend API Tester est utilisé pour démontrer la manière d'émettre des appels d'API pour créer des utilisateur·trices.

Procédure

  1. Dans la page Users, générez un jeton d'accès personnel pour votre compte.
  2. Ouvrez Talend API Tester dans votre navigateur et sélectionnez GET dans la liste Method.
  3. Dans le champ près de la liste déroulante Method, saisissez l'endpoint de gestion des utilisateur·trices à utiliser : https://api.<your_environment>.cloud.talend.com/v1/management/roles
    Votre environnement peut être :
    • eu
    • us
    • us-west
    • ap
    • au
  4. Dans la zone HEADERS (EN-TÊTES), cliquez sur Add header (Ajouter un en-tête). Dans le champ name (nom) qui s'affiche, saisissez Authorization et dans le champ value (valeur), saisissez Bearer, ainsi que votre jeton d'accès personnel. Saisissez un espace afin de séparer Bearer de votre jeton d'accès personnel.
  5. Cliquez sur Send pour émettre votre appel et obtenir l'ID ou les ID de rôle·s à attribuer à l'utilisateur·trice à créer.
    La réponse liste les ID des rôles déjà définis pour vos applications Talend Cloud. Notez l'ID à attribuer à l'utilisateur·trice à créer.
  6. Sélectionnez POST dans la liste Method et, dans le champ à côté, saisissez l'endpoint de gestion à utiliser : https://api.<your_environment>.cloud.talend.com/v1/management/users/

    Exemple

  7. Cliquez sur Add query parameter et, dans les champs name et value, saisissez les paramètres invite et true, respectivement. Cette ligne indique à présent invite = true.
  8. Cliquez sur Add header (Ajouter un en-tête). Dans le champ name qui s'affiche, saisissez Content-Type et, dans le champ value, saisissez application/json.
  9. Dans la zone BODY, saisissez le profil de l'utilisateur·trice à créer.

    Exemple

    {
    	"active": true,
    	"email": "user_email_to_receive_invitation",
    	"firstName": "string",
    	"lastName": "string",
    	"login": "string",
    	"roleIds": [
    		"role_id_retrieved_in_previous_steps"
    	]
    }

    Dans cet exemple, seuls les champs requis sont utilisés dans la création d'utilisateur·trice.

    Si nécessaire, vous pouvez ajouter des champs :
    "password": "string",
    "phone": "string",
    "preferredLanguage": "EN",
    "timezone": "string",
    "title": "string",
    Un mot de passe valide doit contenir plus de sept caractères dont :
    • numbers
    • des majuscules
    • des caractères spéciaux
    • aucune information provenant des champs email (adresse e-mail), firstName (prénom), lastName (nom de famille) ou login (identifiant)
  10. Cliquez sur Send pour émettre votre appel.

Résultats

La création est effectuée et le code de statut 201 est retourné. Dans le champ BODY de la réponse sont affichés les détails de l'utilisateur·trice créé·e.