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

Guide d'utilisation des API Talend Cloud

Version
Cloud
Language
Français
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
Last publication date
2024-04-04
Vous pouvez utiliser l'API de gestion des utilisateur·trices pour créer des utilisateur·trices.

Avant de commencer

  • Générez des jetons d'accès :

    Une fois généré, un jeton de compte de service expire après 30 minutes. S'il expire, générez un nouveau jeton à l'aide de la méthode POST sur l'endpoint https://api.<env>.cloud.talend.com/security/oauth/token. Pour plus d'informations concernant la génération de ce jeton, consultez Générer un jeton de compte de service.

  • Assurez-vous que l'utilisateur·trice ou le compte de service à utiliser pour émettre les appels d'API a l'autorisation Users - Management (Utilisateurs - Gestion).

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. Ouvrez Talend API Tester dans votre navigateur et sélectionnez GET dans la liste Method.
  2. Dans le champ près de la liste déroulante Method (Méthode), saisissez l'endpoint de gestion des utilisateur·trices à utiliser : https://api.<your_environment>.cloud.talend.com/scim/v2/Roles.
    Votre environnement peut être :
    • eu
    • us
    • us-west
    • ap
    • au
  3. 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. Saisissez un espace afin de séparer Bearer du jeton.
  4. 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, dans le champ id, les rôles déjà définis pour vos applications Talend Cloud. Notez l'ID des rôles à attribuer à l'utilisateur·trice à créer.

    Le champ entitlement (autorisation) affiche les détails des autorisations ajoutées à un rôle donné.

  5. Sélectionnez POST dans la liste déroulante Method (Méthode) et, dans le champ proche, saisissez l'endpoint de gestion des utilisateur·trices à utiliser : https://api.<your_environment>.cloud.talend.com/scim/v2/Users.
  6. 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.
  7. Cliquez à nouveau sur Add header (Ajouter un en-tête). Dans le champ name (nom) affiché, saisissez Authorization et, dans le champ value (valeur), saisissez Bearer, ainsi que votre jeton d'accès personnel ou le jeton d'accès du compte de service. Saisissez un espace afin de séparer Bearer du jeton.
  8. Dans la zone BODY, saisissez le profil de l'utilisateur·trice à créer.

    Exemple

    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "user_name_of_your_choice, for example, ychen",
      "password": "initial_password_for_this_user",
      "name": {
        "familyName": "family_name",
        "givenName": "given_name"
      },
      "preferredLanguage": "en",
      "timezone": "Europe/Paris",
      "active": true,
      "emails": [
        {
          "value": "example@company.com",
          "display": "example@company.com",
          "primary": true
        }
      ],
      "roles": [
        {
          "value": "3906e686-5ddd-47de-8e9f-ecae7ec9e6b2"
        }
      ]
    }
  9. 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.