Private Access API REST - Netskope Portail de connaissances

Cette rubrique explique comment utiliser les pages de l'API REST v2 de New dans l'interface utilisateur de Netskope pour les éditeurs et les applications privées de Private Access.

Les API REST de Netskope utilisent un jeton d’authentification pour effectuer des appels autorisés vers l’API. Les API REST de Netskope permettent d’accéder aux ressources via des chemins URI. Le jeton doit être utilisé dans chaque appel API REST pour le locataire. Le jeton peut être créé pour être utilisé avec des API spécifiées dans l’interface Netskope en allant dans Settings > Administration > Administrators & Roles > Administrators et en cliquant sur Service Account.

Créez un jeton New

Le site workflow pour créer un jeton a changé. Pour savoir comment créer un jeton New, cliquez ici.

Documentation de l'API Swagger

Pour consulter les informations sur les paramètres de l'API, cliquez sur le lien API Documentation sur la page REST API v2 ou dans la boîte de dialogue Create REST API Token, qui ouvre l'interface utilisateur Swagger. Les points de terminaison, les méthodes et les paramètres disponibles sont affichés.

Pour voir les informations sur les charges utiles des points d'extrémité dans Swagger :

Cliquez sur l'un des points d'extrémité, comme infrastructure, pour voir les paramètres disponibles. Les points d'extrémité infrastructure sont utilisés pour les API de l'éditeur.
Les points de terminaison steering sont utilisés pour les API des applications privées.
Les descriptions des paramètres fournissent des informations sur les valeurs disponibles, les exigences de format et les facteurs liés à l'utilisation avec d'autres paramètres. Certains paramètres proposent des listes déroulantes pour les options prises en charge, d'autres paramètres utilisent des champs de texte.
Copiez l'URL de la requête de point final et les paramètres à utiliser dans vos appels à l'API. Assurez-vous que le jeton est ajouté à l'en-tête Netskope-Api-Token avant d'envoyer des requêtes ; sinon, vous obtiendrez une erreur.

API de l'éditeur

Liste des API

Créez un éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/createNPAPublishers

Obtenez un éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/getNPAPublisherById

Obtenez une liste des éditeurs :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/getNPAPublishers

Mettre à jour un éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/replaceNPAPublisherByID

Patch a Publisher :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/updateNPAPublisherById

Supprimer un éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/deleteNPAPublishers

Obtenez la conﬁguration des alertes de l'éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/getNPAPublisherAlerts

Mettez à jour la conﬁguration des alertes de l'éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/createNPAPublisherAlerts

Déclencher l'action de mise à jour en bloc de l'éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/triggerNPAPublisherUpdates

Obtenez la liste des publications des éditeurs :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/getNPAPublisherObjects

Obtenir toutes les applications privées associées à un éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/getNPAPublisherApps

Générer et récupérer un jeton d'enregistrement de l'éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/generateNPAPublisherToken

API Parameters

Clé	Type	Exemple	Description
`apps_count`	integer	`3`	Total Private Apps associé à l'éditeur.
`common_name`	string	`e2eabac9e9f715ff`	Un nom unique est généré pour un éditeur.
`connected_apps`	List	`List [ "[Cloud Exchange]", "[WebServer]" ]`	Liste des applications privées connectées à un éditeur.
`id`	integer	`6`	ID de l'éditeur.
`lbrokerconnect`	boolean	`false`	État de la connexion du courtier local de l'éditeur.
`name`	string	`pub1.local`	Nom de l'éditeur.
`publisher_upgrade_profiles_id`	integer	`1`	ID du profil de mise à niveau de l'éditeur.
`adminUsers`	List [string]	`List [ "admin1@abc.com ", "admin2@abc.com " ]`	Liste des utilisateurs présents dans la section admin.
`eventTypes`	string (Enum)	`List [ "CONNECTION_FAILED", "UPGRADE_STARTED" ]`	Liste des types d'événements générés par l'éditeur.
`selectedUsers`	string	`abc@xyz.com,def@xyz.com`	Utilisateurs supplémentaires qui ont besoin des événements des éditeurs.

Mise à jour de l'éditeur Proﬁle APIs

Liste des API

Créez un Proﬁle de mise à jour de l'éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/createNPAPublisherUpgradeProfile

Obtenez un Proﬁle de mise à niveau de l'éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/getNPAPublisherUpgradeProfile

Obtenez une liste de Proﬁles de mise à niveau des éditeurs :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/listNPAPublisherUpgradeProfiles

Mettez en place un Proﬁle de mise à niveau de l'éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/updateNPAPublisherUpgradeProfile

Supprimer un Proﬁle de mise à niveau d'un éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/deleteNPAPublisherUpgradeProfile

Mettre à jour un éditeur Mettre à jour le Proﬁle d'un ensemble d'éditeurs :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/BulkupdateNPAPublishers

API Parameters

Clé	Type	Exemple	Description
`docker_tag`	string	`8690`	Étiquette unique pour chaque version présente dans le docker.
`enabled`	boolean	`true`	Statut du profil de mise à niveau de l'éditeur.
`frequency`	string	`0 0 1 * TUE`	Spécifie la date, l'heure et le mois.
`id`	integer	`10`	L'identifiant unique du profil de l'éditeur.
`publisher_upgrade_profiles_id`	integer	`1`	ID externe du profil de l'éditeur.
`name`	string	`My Upgrade profile`	Nom du profil de l'éditeur.
`release_type`	string	`Latest`	Mentionne la disponibilité de différentes versions de l'éditeur.
`timezone`	string	`US/Eastern`	Sélection des fuseaux horaires.

Applications privées API

Liste des API

Créez une application privée :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/post_api_v2_steering_apps_private

Obtenez une application privée :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/get_api_v2_steering_apps_private_private_app_id_

Obtenir une liste des applications privées :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/get_api_v2_steering_apps_private

Mettre à jour une application privée :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/put_api_v2_steering_apps_private_private_app_id_

Patch a Private App :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/patch_api_v2_steering_apps_private_private_app_id_

Supprimer une application privée :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/delete_api_v2_steering_apps_private_private_app_id_

Obtenez la politique en vigueur pour les applications privées :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/post_api_v2_steering_apps_private_getpolicyinuse

API Parameters

Clé	Type	Exemple	Description
`token`	string	`"token":"<your_token>>"`	Il s'agit d'une obligation. Obtenez le jeton de l'API REST auprès de votre locataire Netskope. Pour savoir comment générer un jeton, consultez la page Créer un New jeton. Nous vous recommandons de placer le jeton dans l'en-tête de la requête, et non dans l'URL du point final.
`app_name`	string	`"app_name": "<application_name>"`	Il s'agit d'une obligation. Nom de l'application(s) privée(s).
`host`	string	`"host":"host.com"`	Il s'agit d'une obligation. Saisissez un FQDN, un domaine de caractères génériques, un sous-réseau IP ou une adresse IP.
`publishers`	array	`"publisher_id":"office-hq"` `"publisher_name":"of ice-private-apps"`	Il s'agit d'une obligation. Le nom et/ou l'ID de l'éditeur qui fournit l'accès à cette application.
`private_app_id`	string	`"private_app_id":"office-365"`	Il s'agit d'une obligation. L'ID de l'application privée à laquelle on accède.
`protocols`	`array`	`"type":"tcp"` `"port":"80"` `"ports":"80,8010-8050"`	Il s'agit d'une obligation. Définit le type de protocole et le(s) port(s). Les valeurs de type sont TCP ou UDP.
`private_app_protocol`	boolean	`"private_app_protocol":"https"`	En option. Protocole utilisé par l'application privée. Les valeurs sont HTTP ou HTTPS.
`clientless_access`	boolean	`"clientless_access": true`	En option. Active l'accès au navigateur pour les applications privées. Les valeurs sont vraies ou fausses. La valeur par défaut est false.
`use_publisher_dns`	boolean	`"use_publisher_dns": true`	En option. Active l'option DNS de l'éditeur. Les valeurs sont vraies ou fausses. La valeur par défaut est false.
`trust_self_signed_certs`	boolean	`"trust_self_signed_certs": true`	En option. Activez cette option si des certiﬁcats auto-signés de confiance doivent être utilisés pour l'accès au navigateur. Les valeurs sont vraies ou fausses. La valeur par défaut est false.
`fields`	string	`“fields: id, name, host}`	En option. Renvoie les champs spécifiés dans l'objet JSON pour la méthode GET.
`silent`	boolean	`"silent": 1`	En option. Affiche le code d'état mais ignore le code de données. Les valeurs sont 1 (vrai) ou 0 (faux). La valeur par défaut est 0.
`is_user_portal_app`	boolean	`true`	Statut de l'application du portail utilisateur.
`allow_unauthenticated_cors`	boolean	`false`	Statut du CORS.
`uri_bypass_header-value`	string	`X-NSKP-URIBYPASS`	En-tête de contournement de l'URI.
`bypass_uris`	[string]	`["/1/", "/2/",... "/20/"]`	Liste des URI à contourner.
`app_option`	{}	Il n'est pas utilisé actuellement. Ignorer.	(Facultatif) Option utilisée par RDP/SSH.
`tags`	String [{tag_id, tag_name}]	`[{tag_id, tag_name}]`	Liste des tags de l'application Private
`real_host`	string	`www.use-fqdn.com`	Hôte utilisé principalement pour l'accès par navigateur.

NPA Real-Time Policy APIs (API de politique en temps réel)

Liste des API

Créez une politique NPA en temps réel :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/policy/post_api_v2_policy_npa_rules

Obtenez une politique en temps réel du NPA :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/policy/get_api_v2_policy_npa_rules_id_

Obtenez les politiques en temps réel du NPA :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/policy/get_api_v2_policy_npa_rules

Patch an NPA Real-Time Policy (Politique en temps réel du NPA) :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/policy/patch_api_v2_policy_npa_rules_id_

Supprimez une politique en temps réel du NPA :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/policy/delete_api_v2_policy_npa_rules_id_

API Parameters

Clé	Type	Exemple	Description
`description`	string	`This is a NPA real time policy.`	Description de la politique. Cette valeur n'apparaît actuellement pas dans le locataire Netskope.
`enabled`	string	`policy_name`	Statut de la politique en temps réel.
`group_id`	string	`1`	ID du groupe de politiques.
`group_name`	string	`policy_group`	Nom du groupe de politiques.
`rule_data`	npa_policy_rule_data	Exemple trop grand pour être montré.	Structure de la politique en temps réel.
`access_method`	[string] Enum [Client, sans client]	`[Client]`	Il peut être basé sur le client ou sans client.
`dlp_actions`	{actions, dlp_profile}	`{“Allow”, “Payment Card”}`	Actions pour la fonctionnalité DLP (Prévention des pertes de données)
`actions`	String Enum : autoriser, bloquer, alerter, mettre en quarantaine, contourner	`[“allow”]`	Un des enums à sélectionner.
`dlp_profile`	string	`“Payment Card”`	Il s'agit de profils prédéfinis.
`tss_actions`	{nom_de_l'action, profil_de_la_remédiation, gravité, modèle}	`{ Action_name: “allow”, Remediation_profile: “None”, Severity: “medium” }`	Actions pour la rubrique TSS.
`action_name`	string Enum : [block, alert, allow]	`[“alert”]`	Un des enums à sélectionner.
`remediation_profile`	string	`“profile_remedy”`	Sans objet pour la NPA.
`severity`	string Enum : [low, medium, high]	`[medium]`	Un des Enums à sélectionner.
`template`	string	Default template or Custom template	Nom du modèle de bloc créé pour la notification à l'utilisateur.
`tss_profile`	[string]	Profil par défaut ou profil personnalisé	Profil d'analyse pour le profil de protection contre les menaces.
`json_version`	integer	`3`	(Facultatif) Il s'agit d'une valeur fixe qui ne changera pas.
`device_classification_id`	[integer]	`[45]`	Liste des ID de classification du périphérique.
`match_criteria_action`	string action_name Enum [allow, block]	`[“allow”]`	Nom de l'action de la politique de RT.
`policy_type`	chaîne "private-app"	`“private-app”`	Ce point est fixé et ne changera pas.
`privateAppTagIds`	List [string]	`List [“1”,“2”]`	Liste des identifiants de balises.
`privateAppTags`	List [string]	`List [“tag1”,“tag2”]`	Liste des balises d’application privée.
`privateApps`	List [string]	`List [“app1”,“app2”]`	Liste des noms d’applications privées.
`privateAppsWithActivities`	Activités liées aux fichiers, avec taille et type.	`[ { "activities": [ { "activity": "any", "list_of_constraints": [] } ], "appName": "[172.31.12.135]" } ] /code>`	Applicable au TSS et au DLP (Prévention des pertes de données).
`userGroups`	List [string]	`[“user/group1/group2”]`	Liste des utilisateurs du groupe.
`userType`	chaîne Enum : [utilisateur]	`[“user”]`	Ce point est fixé et ne changera pas.
`users`	[utilisateur]	`[“user@netskope.com”]`	Il est possible d'ajouter une liste d'utilisateurs disponibles.
`organization_units`	List[string]	`List [“engineering/qa”]`	Il est possible d'ajouter une liste d'unités organisationnelles.
`rule_name`	string	`npa-policy-name`	Nom de la police en temps réel.
`rule_order`	npa_rule_order	`{order,position, rule_id,rule_name}`	Structure pour la rule_order où la police New à placer.
`order`	chaîne Enum : [haut, bas, avant, après]	`“top”`	Position où la politique en temps réel doit être mise en place.
`position`	integer	`5`	(Optionnel) Valeur d’ordre de règles existante.
`rule_id`	integer	`1`	L’identifiant de règle existait dans la politique.
`rule_name`	string	`policy-name`	Nom de la politique existante dans l'ordre des règles.

NPA API sur les groupes de politiques

Liste des API

Créez des groupes de politiques NPA :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/policy/post_api_v2_policy_npa_policygroups

Créez un groupe de politique NPA :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/policy/get_api_v2_policy_npa_policygroups_id_

Obtenez les groupes politiques du NPA :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/policy/get_api_v2_policy_npa_policygroups

Patch NPA Policy Groups :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/policy/patch_api_v2_policy_npa_policygroups_id_

Supprimez les groupes de politiques NPA :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/policy/delete_api_v2_policy_npa_policygroups_id_

API Parameters

Clé	Type	Exemple	Description
`group_id`	integer	`4`	ID du groupe de politiques.
`group_name`	string	`npa-policy-group`	Nom du groupe de politiques.
`group_order`	Il s'agit d'une structure.	`{group_id: 1, "Order": before\|after}`	Structure de commande du groupe.
`group_id`	string	`"1"`	Référence de l'ID du groupe existant.
`order`	string	`"before\|after"`	Position où le groupe New doit être placé.

API de paramètres de découverte du NPA

Liste des API

Créez les paramètres de découverte du NPA :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/post_api_v2_steering_apps_private_discoverysettings

Obtenir les paramètres de découverte du NPA :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/get_api_v2_steering_apps_private_discoverysettings

API Parameters

Clé	Type	Exemple	Description
`host`	List [string]	`[“www.netskope.com”, “10.31.13.12”]`	Une liste de FQDN et d'IP peut être fournie.
`organization_units`	List [string]	`[“org/qa”]`	Liste des unités Org.
`publishers`	{id_éditeur, nom_éditeur, nom_éditeur}	`{“132”,“netskope_publisher”, “d48fb11de337a0 f”}`	Liste des éditeurs.
`publisher_id`	string	`“132”`	ID unique de l'éditeur.
`publisher_name`	string	`netskope_publisher`	Nom de l'éditeur.
`publisher_cn`	string	`d48fb11de337a0f`	Identifiant unique commun de l'éditeur.
`status`	string Enum: [“ENABLED”, “DISABLED”]	`ENABLED`	Statut de la découverte de l'application.
`users`	List [string]	`[“abc@netskope.com”]`	Liste des utilisateurs.
`userGroups`	List [string]	`[“users/group1”]`	Liste des groupes d'utilisateurs.

NPA Private App Publishers Association APIs

Liste des API

Mettre à jour un éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/put_api_v2_steering_apps_private_publishers

Patch a Publisher :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/patch_api_v2_steering_apps_private_publishers

Supprimer un éditeur :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/delete_api_v2_steering_apps_private_publishers

API Parameters

Clé	Type	Exemple	Description
`private_app_ids`	List [string]	`[“1”, “48”]`	Liste des identifiants d'applications privées à fournir.
`publisher_ids`	List [string]	`[“56”, “69”]`	Liste des identifiants de l'éditeur à fournir.

NPA Private App Tags APIs

Liste des API

Créez des étiquettes d'applications privées :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/post_api_v2_steering_apps_private_tags

Obtenez une étiquette d'application privée :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/get_api_v2_steering_apps_private_tags_tag_id_

Obtenez une liste des étiquettes d'applications privées :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/get_api_v2_steering_apps_private_tags

Update a Private App Tags:

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/put_api_v2_steering_apps_private_private_app_id_

Patch d'un Private App Tag (Bulk Private App update) :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/patch_api_v2_steering_apps_private_tags

Supprimer une étiquette d'application privée :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/delete_api_v2_steering_apps_private_tags_tag_id_

Supprimer une application privée avec association de balises :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/delete_api_v2_steering_apps_private_tags

Obtenez le nombre de politiques en cours d'utilisation pour les balises d'applications privées :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/post_api_v2_steering_apps_private_tags_getpolicyinuse

Mettez à jour les balises de l'application privée en fonction de l'identifiant de la balise :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/steering/put_api_v2_steering_apps_private_tags_tag_id_

API Parameters

Clé	Type	Exemple	Description
`id`	string	`“23”, “13”`	Il s'agit de l'identifiant de l'application privée.
`tags`	{[tag_name]}	`[{“tag1”},{“tag2”}]`	Format attendu.
`tag_name`	string	`“tag1”`	Nom de l'étiquette.
`ids`	[string]	`[“2”, “5”]`	Liste des identifiants des applications privées.

API du courtier local

Liste des API

Créez un courtier local :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/post_api_v2_infrastructure_lbrokers

Faites appel à un courtier local :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/get_api_v2_infrastructure_lbrokers id_

Obtenez une liste de courtiers locaux :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/get_api_v2_infrastructure_lbrokers

Mettre à jour un courtier local :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/put_api_v2_infrastructure_lbrokers_id_

Supprimer un courtier local :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/delete_api_v2_infrastructure_lbrokers_id_

Create a Local Broker Hostname Conﬁg:

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/post_api_v2_infrastructure_lbrokers_brokerconfig

Update a Local Broker Hostname Conﬁg:

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/put_api_v2_infrastructure_lbrokers_brokerconfig

Get a Local Broker Hostname Conﬁg:

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/get_api_v2_infrastructure_lbrokers_brokerconfig

Générer et récupérer le jeton d'enregistrement du courtier local :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/post_api_v2_infrastructure_lbrokers_id_registrationtoken

Vérifiez si le nom fourni est un duplicata valide ou non :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/get_api_v2_infrastructure_npa_namevalidation

Validez la ressource en fonction du type de ressource :

https://<tenant-URL>/apidocs/?include_beta_routes=1#/infrastructure/post_api_v2_infrastructure_npa_resource_validation_resourcetype_

API Parameters

Clé	Type	Exemple	Description
`name`	string	`localbroker1`	Nom du courtier local.
`common_name`	string	`d48fb11de337a0f`	Nom commun du courtier local
`id`	integer	`45`	ID unique du courtier local.
`registered`	boolean	`true`	Statut de l'enregistrement du courtier local.
`hostname`	string	`www.localconnect.com`	FQDN du DNS du courtier local.