Modifier le propriétaire d'un tableau de bord via l'API REST

Les tableaux de bord appartiennent à l'utilisateur connecté qui les a créés. Si un utilisateur ne fait plus partie de votre entreprise, il se peut que vous deviez changer le propriétaire du tableau de bord pour le maintenir à jour.

Pour transférer la propriété d'un tableau de bord, vous avez besoin de l'ID du tableau de bord et du nom d'utilisateur du propriétaire du tableau de bord. Vous pouvez uniquement consulter le nom d'utilisateur du propriétaire d'un tableau de bord via l'API REST.

Before you begin

Récupérez les identifiants du tableau de bord

  1. Dans un navigateur, accédez à l'explorateur d'API REST.
    L'URL est le nom d'hôte ou l'adresse IP de votre sonde ou console, suivi par /api/v1/explore/. Par exemple, si votre nom d'hôte est seattle-eda, l'URL est https://seattle-eda/api/v1/explore/.
  2. Entrez les informations d'identification de votre API REST.
    • Pour les capteurs et les machines virtuelles ECA, cliquez Entrez la clé API puis collez ou saisissez votre clé API dans le Clé API champ.
    • Pour RevealX 360, cliquez sur Entrez les identifiants de l'API puis collez ou saisissez l'ID et le code secret de vos informations diciatives d'API dans le IDENTIFIANT et Secret champs.
  3. Cliquez Autoriser puis cliquez sur Fermer.
  4. Cliquez Tableau de bord pour afficher les opérations du tableau de bord.
  5. Cliquez GET /tableaux de bord.
  6. Cliquez Essayez-le puis cliquez sur Envoyer la demande pour envoyer la demande à votre sonde ou à votre console.
  7. Recherchez les tableaux de bord à l'aide du nom du tableau de bord ou du compte utilisateur répertorié dans "owner" champ. Si votre liste de tableaux de bord est longue, vous pouvez appuyer sur Ctrl+f et effectuer une recherche dans le corps de la réponse.
    Pour notre exemple, nous voulons modifier le "LDAP Server Health" tableau de bord créé par le compte utilisateur pour "marksmith":
    {
        "id": 1876,
        "comment": null,
        "mod_time": 1507576983922,
        "author": "Mark Smith",
        "name": "LDAP Server Health",
        "owner": "marksmith",
        "built-in": false,
        "short_code": "MpXgk",
        "rights": [
          "transfer",
          "view",
          "edit",
          "share",
          "delete"
        ]
    }
  8. Notez le numéro dans "id" champ pour chaque tableau de bord que vous souhaitez modifier.

Changer le propriétaire du tableau de bord

  1. Faites défiler la page des opérations du tableau de bord vers le bas jusqu'à la section /dashboards/ {id}.
  2. Cliquez PATCH /tableaux de bords/ {id}.
  3. Cliquez Essayez-le.
    Le schéma JSON est automatiquement ajouté à la zone de texte du paramètre du corps.
  4. Dans la zone de texte du corps de texte, "owner" champ, remplacez string avec le nom d'utilisateur du nouveau propriétaire.
  5. Dans le identifiant champ, saisissez le numéro que vous avez noté précédemment pour le tableau de bord.
    Pour notre exemple, cette valeur est 1876. (Vous ne pouvez modifier qu' un seul tableau de bord à la fois via l'explorateur d'API REST.)
    Dans la figure suivante, nous avons ajouté le JSON "string" pour le "owner" paramètre du corps zone de texte du paramètre, modifiée "string" à "paulanderson", et tapé "1876" dans le identifiant champ.
  6. Cliquez Envoyer la demande pour envoyer la demande à votre sonde ou à votre console.
    En dessous Réponse du serveur, le Code affichages de colonnes 204 si l' opération est réussie. Vous pouvez cliquer GET /tableaux de bord à nouveau pour vérifier que "owner" le champ a changé. Notez que vous ne pouvez modifier que le propriétaire du tableau de bord. Vous ne pouvez pas modifier le nom du tableau de bord ni les champs d'auteur via l'API REST.

    Le tableau de bord est désormais disponible sous Mes tableaux de bord dans le système ExtraHop pour le nouvel utilisateur. En tant que nouveau propriétaire, vous pouvez désormais vous connecter à votre système ExtraHop et modifier d'autres propriétés du tableau de bord, telles que le nom ou l'auteur du tableau de bord.

Conseil :Après avoir cliqué Envoyer la demande, l' explorateur d'API REST fournit des scripts pour les opérations dans Curl, Python 2.7 ou Ruby.

Exemple de script Python

Le référentiel GitHub d'ExtraHop contient un exemple de script Python qui recherche tous les tableaux de bord appartenant à un compte utilisateur sur un sonde ou console puis remplace le propriétaire de tous ces tableaux de bord par un autre compte utilisateur.

Important :L'exemple de script python s'authentifie auprès de la sonde ou de la console via une clé API, qui n'est pas compatible avec l'API REST RevealX 360 . Pour exécuter ce script avec RevealX 360, vous devez le modifier pour vous authentifier à l'aide de jetons d'API. Consultez les py_rx360_auth.py script dans le référentiel GitHub d'ExtraHop pour un exemple d'authentification à l'aide de jetons d'API.
  1. Accédez au Référentiel GitHub d'exemples de code ExtraHop et téléchargez le change_dashboard_owner/change_dashboard_owner.py fichier sur votre machine locale.
  2. Dans un éditeur de texte, ouvrez change_dashboard_owner.py archivez et remplacez les variables de configuration suivantes par des informations provenant de votre environnement :

    HÔTE: L'adresse IP ou le nom d'hôte de la sonde ou de la console.

    CLÉ_API: La clé d'API.

    ACTUEL: Le nom d'utilisateur du propriétaire actuel du tableau de bord.

    NOUVEAU: Le nom d'utilisateur du nouveau propriétaire du tableau de bord.

  3. Exécutez la commande suivante :
    python3 change_dashboard_owner.py
    Remarque :Si le script renvoie un message d'erreur indiquant que la vérification du certificat TLS a échoué, assurez-vous que un certificat fiable a été ajouté à votre sonde ou à votre console. Vous pouvez également ajouter verify=False option permettant de contourner la vérification des certificats. Cependant, cette méthode n'est pas sûre et n'est pas recommandée. Le code suivant envoie une requête HTTP GET sans vérification du certificat :
    requests.get(url, headers=headers, verify=False)
Last modified 2024-09-26