Vous pouvez désormais utiliser l’API REST v2 pour afficher, créer, lire, mettre à jour et supprimer (opérations CRUD) pour Netskope Client. Utilisez l’API pour automatiser les modifications répétitives, maintenir la cohérence des configurations entre vos unités organisationnelles (UO) et vos groupes, et connecter les configurations à vos propres outils et scripts. Pour en savoir plus, allez sur Settings > Tools > REST API v2 > API Documentation pour accéder à la documentation Swagger.
- Cette fonctionnalité est en version bêta. Contactez l'assistance Netskope pour rendre ceci disponible dans votre locataire.
- Assurez-vous que l’interface Web de configuration améliorée du client est activée pour votre locataire. L’API REST v2 fonctionne uniquement avec l’interface Web de configuration améliorée du client.
Prerequisites
Avant de gérer Client à l’aide de l’API REST v2, assurez-vous de disposer des éléments suivants :
-
Confirmez que les points de terminaison sont disponibles pour votre locataire. Accédez à Settings > Tools > REST API v2 > API Documentation et recherchez la section spécifique correspondant à l’ensemble d’API. Par exemple, pour la configuration du client, recherchez la section clientconfiguraation.
-
Obtenez un jeton API REST v2 valide auprès d’un compte de service. Vous pouvez créer un compte de service sous Settings > Administration > Administrators & Roles > Administrators. Incluez le jeton dans chaque demande : [En-tête de confirmation : Authorization: Bearer <token> ou Netskope-Api-Token: <token>]. Pour plus de détails, consultez la vue d’ensemble de l’API REST v2.
-
Assurez-vous que le rôle du compte de service accorde un accès de type « View » (Afficher) pour les opérations de lecture, ou un accès de type « Manage » (Gérer) pour les opérations de création, de mise à jour et de suppression. Les appels API sont soumis à un contrôle d'accès basé sur les rôles. Pour en savoir plus, consultez Configurer le contrôle d'accès RBAC (Role Based Access Control).
-
Allowlist API client source IP addresses. Si les restrictions IP sont activées, assurez-vous que vos scripts et intégrations REST API v2 se connectent à partir d'adresses IP sources autorisées :
-
Si une liste d’autorisation IP basée sur les rôles est activée pour le rôle affecté au compte de service, ajoutez les adresses IP sources à cette liste d’autorisation. La liste d’autorisation basée sur les rôles prévaut sur la liste d’autorisation IP globale. L’ajout d’adresses uniquement à la liste IP personnalisée globale ne donne donc pas accès.
-
Si aucune liste autorisée basée sur les rôles ne s’applique, ajoutez les adresses IP source à la liste IP personnalisée sous Settings > Administration > IP Allowlist. Cela s’applique lorsque la liste autorisée IP globale est activée.
-
-
Assurez-vous que les fonctionnalités associées aux paramètres que vous prévoyez de configurer sont activées pour votre tenant. Certains paramètres ne sont disponibles que lorsque la fonctionnalité correspondante du tenant est activée.
Toutes les requêtes utilisent cette URL de base :
https://<tenant-name>.goskope.com/api/v2/
Tous les chemins de point de terminaison dans cette rubrique sont relatifs à cette URL de base. Par exemple, clientconfiguration/client/config signifie https://<tenant-name>.goskope.com/api/v2/clientconfiguration/client/config . Les exemples curl montrent l’URL complète. Remplacez <tenant-name> par le nom de votre locataire.
Envoyez votre jeton dans l’en-tête Authorization de chaque demande, au format Authorization: Bearer <token>.
Client Configurations Using REST API v2
Gérez les configurations Netskope Client par programme à l’aide de l’API REST v2, sans vous connecter à l’interface utilisateur de Netskope. Accédez à Settings > Tools > REST API v2 > API Documentation et recherchez la section clientconfiguration pour obtenir l’ensemble de l’API REST v2 pour Client Configuration.
Endpoints
Tous les chemins sont relatifs à :
/api/v2/clientconfiguration
Client Configurations Endpoints
Le tableau liste les points de terminaison de l’API REST v2 disponibles pour la configuration du client.
| Méthode | Endpoint | Description |
|---|---|---|
| OBTENIR | /client/config | Liste les configurations du Client. Prend en charge la recherche par nom, la pagination et le filtrage par cible. |
| PUBLIER | /client/config | Crée une configuration client. |
| OBTENIR | /client/config/{id} | Renvoie une configuration du Client. |
| PATCH | /client/config/{id} | Met à jour uniquement les champs envoyés. |
| DELETE | /client/config/{id} | Supprime une configuration Client. |
| PUBLIER | /client/config/bulkdelete | Démarre une tâche asynchrone qui supprime toutes les configurations à l’exception de la configuration par défaut. |
| OBTENIR | /client/config/bulkstatus/{jobid} | Renvoie l'état d'une tâche de suppression en masse. |
| OBTENIR | /client/versions | Répertorie les versions du Client que vous pouvez utiliser dans les politiques de mise à jour. |
| OBTENIR | /client/platforms | Liste les plateformes prises en charge et les versions minimales du client pour la désactivation unique. |
| OBTENIR | /client/gslbpops | Liste les options de zone GSLB disponibles et leurs UUID pour la sélection de zone de configuration client. |
| OBTENIR | /client/config/swgglobalattributes | Renvoie l’état actuel de tous les attributs globaux de la sécurité Internet pour votre locataire. |
| PATCH | /client/config/swgglobalattributes | Active ou désactive un ou plusieurs attributs globaux de la sécurité Internet. |