Créer une action pour supprimer un utilisateur

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 5 minutes de lecture

    • Créez une action pour désactiver ou supprimer un compte utilisateur dans l’application SaaS.

    Avant de commencer

    Si vous utilisez un spoke existant ServiceNow® Hub d'intégration , vérifiez s’il dispose d’une action permettant de supprimer un utilisateur que vous pouvez utiliser au lieu d’en créer un.

    Rôle requis : flow_designer ou admin

    Pourquoi et quand exécuter cette tâche

    Cette action est utilisée pour récupérer les abonnements inutilisés afin de réduire les dépenses logicielles de votre entreprise.

    Procédure

    1. Accédez à la Tout > Concepteur de flux > Concepteur.
    2. Cliquez sur Nouveau , puis sélectionnez Action.
    3. Renseignez les champs du formulaire.
      Tableau 1. Formulaire Propriétés de l’action
      Champ Valeur
      Nom Nom de votre choix. Par exemple, Supprimer un utilisateur.
      Accessible depuis Tous les périmètres de l’application.
      Catégorie Laissez ce champ vide.
      Protection Aucune.
      Application Application de spoke à intégrer à l’application SaaS. Il peut s’agir d’un spoke existant Hub d'intégration ou d’un nouveau spoke que vous avez créé.
      Annotation dans le flux Laissez ce champ vide.
      Description Description de votre choix.
    4. Cliquez sur Envoyer.
    5. Dans la section Entrées du Plan d’action, cliquez sur Créer une entrée.
    6. Ajoutez une entrée d’ID d’utilisateur.

      C’est ainsi que l’action obtient l’ID utilisateur de l’utilisateur à supprimer.

      Tableau 2. Entrées
      Étiquette Nom Type Obligatoire
      ID d'utilisateur userID Chaîne Oui
    7. Si l’API avec laquelle vous travaillez exige une authentification de l’utilisateur pour les demandes, ajoutez des entrées pour l’authentification.
      L’ID d’utilisateur administrateur et le nom du site sont des exemples d’entrées d’authentification utilisateur courantes. Consultez la documentation de l’API choisie pour en savoir plus sur les exigences en matière d’authentification utilisateur dans votre cas spécifique. Si l’API nécessite un jeton d’accès, une variable Valeur d’informations d’identification est automatiquement créée ultérieurement. Vous n’avez donc pas besoin de l’ajouter en tant qu’entrée.

      Lorsque vous utilisez votre action terminée dans un flux secondaire, vous définissez les valeurs à transmettre comme entrées.

    8. Ajoutez une étape SOAP ou REST au plan d’action.
      Votre choix dépendra de l’API de l’application SaaS à laquelle vous intégrez.
    9. Si vous avez sélectionné SOAP, remplissez le formulaire comme indiqué.
      Tableau 3. Formulaire de l’étape SOAP
      Champ Valeur
      Détails de la connexion
      Connexion Utilisez un alias de connexion.
      Alias de connexion Alias de connexion que vous avez créé lors de la création du profil d’intégration. Si vous n’avez pas encore créé de profil d’intégration, suivez les étapes pour créer un profil d’intégration personnalisé avec un alias de connexion.
      Point de terminaison Cette valeur est automatiquement renseignée lorsque vous sélectionnez l’alias de connexion. Il est défini sur l’URL de connexion à partir de l’enregistrement de connexion HTTP(s) lié à l’alias.
      Détails de la demande
      Enveloppe de version Manuellement.
      Action SOAP Demande API pour supprimer ou désactiver un utilisateur. Consultez la documentation de l’API choisie pour sélectionner la demande appropriée.
      Enveloppe SOAP Message de demande XML pour supprimer un utilisateur. Consultez la documentation de l’API choisie pour apprendre à écrire un message de requête XML. En général, l’en-tête doit contenir vos variables d’entrée pour l’authentification de l’utilisateur ainsi que la variable Valeur d’informations d’identification comme jeton d’accès. Le corps doit inclure la demande de suppression d’un utilisateur et l’entrée de l’ID de l’utilisateur.
      Remarque :
      Pour obtenir un exemple d’enveloppe SOAP, reportez-vous à l’action Supprimer l’utilisateur utilisée dans le flux secondaire Récupérer l’abonnement Webex .
    10. Si vous avez choisi REST, remplissez le formulaire comme indiqué.
      Tableau 4. Formulaire Étape REST
      Champ Valeur
      Détails de la connexion
      Connexion Utilisez un alias de connexion.
      Alias de connexion Alias de connexion que vous avez créé lors de la création du profil d’intégration. Si vous n’avez pas encore créé de profil d’intégration, suivez les étapes pour créer un profil d’intégration personnalisé avec un alias de connexion.
      URL de base Cette valeur est automatiquement renseignée lorsque vous sélectionnez l’alias de connexion. Il est défini sur l’URL de connexion à partir de l’enregistrement de connexion HTTP(s) lié à l’alias.
      Détails de la demande
      Demande de version Manuellement.
      Chemin d'accès à la ressource Chemin d’accès à la ressource. Cette valeur est ajoutée à l’URL de base. Consultez la documentation de l’API avec laquelle vous travaillez pour savoir comment construire le chemin d’accès de la ressource.
      Fonction de message REST SUPPRIMER.
      Paramètres de requêtes Ajoutez un paramètre pour l’ID d’utilisateur. Définissez la valeur en tant qu’entrée ID d’utilisateur.
    11. Ajoutez une étape de script au plan d’action pour la gestion des erreurs.
      1. Pour Required Runtime (Exécution requise), sélectionnez Instance (Instance).
      2. Créer des variables d’entrée.
        Tableau 5. Variables d'entrée
        Nom Valeur
        response Corps de la réponse sortie de l’étape SOAP ou REST
        status_code Sortie de code d’état à partir de l’étape SOAP ou REST
      3. Créez des variables de sortie.
        Tableau 6. Variables de sortie
        Étiquette Nom Type Obligatoire
        état état Choix Oui
        error_message error_message Chaîne Oui
      4. Dans le champ Script , écrivez un script pour attribuer des valeurs aux sorties d’état et de message d’erreur.
        • Utilisez l’entrée status_code pour vérifier s’il y a une erreur. Définissez la sortie d’état sur Erreur s’il y a une erreur et sur Réussite s’il n’y a pas d’erreur.
        • En cas d’erreur, utilisez l’entrée de réponse pour obtenir des informations sur le type d’erreur. Définissez la sortie du message d’erreur sur une description de l’erreur afin qu’un utilisateur puisse comprendre ce qui s’est mal passé.
    12. Dans Plan d’action, cliquez sur Sorties.
    13. Créez des variables de sortie.
      Tableau 7. Variables de sortie
      Étiquette Nom Type Obligatoire
      Statut état Choix Non
      Message d'erreur error_message Chaîne Non
    14. Attribuez des valeurs aux variables de sortie.
      Tableau 8. Variables de sortie
      Étiquette Valeur
      Statut Variable de sortie d’état de l’étape Script
      Message d'erreur error_message variable de sortie de l’étape de script
    15. Pour tester votre action, cliquez sur Tester.
      1. Affichez les résultats des tests et les journaux système pour plus de détails sur les erreurs.
        Pour afficher les journaux système, accédez à Journaux Système > Journal système > Tout.
      2. Si votre action comporte des erreurs, assurez-vous que vous utilisez les bons points de terminaison et que la demande d’API est structurée comme prévu.
      Remarque :
      Lors du test, n’oubliez pas que cette action désactive un utilisateur. Tester cette action dans un environnement de sous-production. Si seul un environnement de production est disponible, vous pouvez créer de faux utilisateurs pour les tester.
    16. Après avoir vérifié que l’action fonctionne comme prévu, cliquez sur Publier.