Récupérer les API de rôle utilisateur ESA à l'aide de l'API Privileges

Introduction

Ce document décrit comment récupérer des informations de privilège pour le rôle ESA authentifié à l'aide du point d'extrémité /esa/api/v2.0/login/privileges.

Environnement

• Python 3.x
• Python demande l'installation de la bibliothèque
• Appareil de sécurité de la messagerie électronique (ESA) avec le service API activé sur l'interface de gestion et avec le port API configuré

Résolution

1. Vérifiez que le service d'API ESA est activé sur l'interface de gestion.
2. Confirmez le port API configuré sur l'ESA et utilisez la même valeur de port dans le script.
3. Obtenez une valeur d'en-tête Authorization et un cookie de session ESA valide pour le compte utilisé pour appeler l'API.
4. Si nécessaire, installez la dépendance requise :

   pip install requests

5. Mettez à jour la variable de script (adresse IP ESA, port API et valeurs d'authentification), puis exécutez le script.

Remarque : Utilisez le port API configuré sur l'ESA. Maintenez la valeur du port cohérente dans le script et dans les captures d'écran.

Interprétation de la réponse

La réponse /login/privileges représente les privilèges accordés à la session authentifiée. Utilisez la liste de privilèges renvoyée pour déterminer quelles ressources et opérations API sont disponibles pour le rôle d'utilisateur actuel.

Dans la charge utile JSON, passez en revue data.privileges. Chaque entrée répertorie un chemin d'accès à une ressource et les méthodes HTTP autorisées pour cette ressource.

Autres informations utiles

2) Les demandes d'installation (il n'est pas installé avec Python par défaut). Exécutez cette commande à partir d'une invite de commandes :

pip install requests

permet d'envoyer des requêtes HTTP depuis Python.

3) print est inclus avec Python (bibliothèque standard). Aucune installation n'est requise.

Le module d'impression fournit une capacité d'impression de structures de données Python arbitraires dans un format qui peut être utilisé comme entrée pour l'interpréteur et les afficher dans un format lisible. Ce module est facultatif. Le script peut utiliser print à la place ; cependant, le résultat est moins lisible.

 JSON n'a PAS besoin d'être installé séparément car il fait partie de la bibliothèque standard.

Problème

Déterminez les API ESA (Email Security Appliance) Cisco accessibles au rôle d'utilisateur authentifié.

Motif

L'accès à l'API sur l'ESA est contrôlé par les privilèges attribués à la session et au rôle authentifiés. Le point de terminaison /esa/api/v2.0/login/privileges renvoie la liste des privilèges effectifs afin que vous puissiez déterminer quelles ressources API et méthodes HTTP sont autorisées pour l'utilisateur actuel.

Résultat attendu

Une demande GET réussie vers /esa/api/v2.0/login/privileges retourne HTTP 200 OK et une charge utile JSON qui répertorie les privilèges (accès à l'API) disponibles pour la session authentifiée. Examinez le JSON renvoyé pour identifier les ressources et les opérations API autorisées pour ce rôle.

Résolution

Procédure

import requests
import json
import pprint

url = "https://192.0.2.10:6080/esa/api/v2.0/login/privileges"
headers = {
"Authorization": "Basic <BASE64_BASIC_AUTH>",
    "Cookie": "<SESSION_COOKIE>"
}

response = requests.request("GET", url, headers=headers, verify=True)
json_string = json.loads(response.content)
pprint.pprint(json_string)

Exemple de rapport 

Exemple de rapport :

{
  "data": {
    "privileges": [
      {
        "resource": "/esa/api/v2.0/login/privileges",
        "methods": ["GET"]
      }
    ]
  }
}

Consultez la liste des privilèges pour identifier les ressources API et les méthodes HTTP autorisées pour la session authentifiée.

Historique de révision

Révision	Date de publication	Commentaires
1.0	01-Oct-2026	Première publication