Configuration de l’API : Activation de l’API XML et configuration de champs personnalisés

Gestion

Configuration de l’API

Activer l’API XML

Vous pouvez choisir d’activer l’API XML BeyondTrust, qui permet d’exécuter des rapports et des commandes, comme le démarrage ou le transfert de sessions depuis des applications externes, ainsi que de sauvegarder automatiquement votre configuration logicielle.

seuls les appels d’API de commande, de génération de rapports et de script client sont activés/désactivés par ce paramètre. Les autres appels d’API doivent être configurés sous Portails publics.

Pour plus d’informations, veuillez consulter le Guide du programmeur de l’API.

Téléchargement de Client CLI

L’outil CLI (interface de ligne de commande) peut être téléchargé pour faciliter l’utilisation et la configuration des API et des scripts d’automatisation, et pour les intégrer à votre installation BeyondTrust Remote Support. L’outil CLI est disponible pour les plateformes Windows (x64), macOS et Linux (x64). Sélectionnez la plateforme adéquate et cliquez sur Télécharger le Client CLI btapi.

Le téléchargement est un fichier exécutable compressé. Extrayez le fichier et enregistrez-le, ou liez-le à partir d’une zone exécutable (dans votre PATH).

Pour les systèmes Windows : Ouvrez le fichier dans un terminal tel que l’invite de commandes Windows ou Windows PowerShell.
Pour les systèmes macOS : Exécutez le fichier dans le terminal.

Les informations d’aide, y compris les options, les commandes et les instructions relatives aux variables, s’affichent à l’ouverture du programme.

Activer l’API d’archivage

Choisissez d’activer l’API d’archivage d’état pour télécharger des journaux de l’état du B Series Appliance et des évènements qui se sont déroulés à une date donnée.

Comptes d’API

Un compte API stocke tous les paramètres d’authentification et d’autorisation pour le client d’API. Au moins un compte d’API est nécessaire pour utiliser l’API, soit en conjonction avec le client d’intégration, soit avec une application tierce, soit avec votre propre logiciel.

Ajouter, modifier, supprimer

Créer un nouveau compte, modifier un compte existant, ou supprimer un compte existant.

Ajouter ou modifier un compte d’API

Activé

Si cette option est cochée, ce compte est autorisé à s’authentifier auprès de l’API. Lorsqu’un compte est désactivé, tous les jetons OAuth associés au compte sont immédiatement désactivés.

Nom

Créez un nom unique permettant d’identifier ce compte.

Identifiant client OAuth

l’ID client OAuth et le secret de client sont utilisés pour créer des jetons OAuth, nécessaires pour l’authentification à l’API.

L’ID client OAuth est un identificateur unique généré par la B Series Appliance. Il ne peut pas être modifié. L’ID client est considérée comme information publique et peut donc être partagée sans compromettre la sécurité de l’intégration.

Commentaires

Ajoutez des commentaires pour identifier la fonction de ce compte.

Secret de client OAuth

Le secret de client OAuth est généré par l'B Series Appliance grâce à un générateur de nombres pseudo-aléatoire sécurisé cryptographiquement.

le secret de client ne peut pas être modifié, mais il peut être généré à nouveau sur la page Modifier. Générer un nouveau secret de client et enregistrer le compte rend immédiatement invalides tous les jetons OAuth associés à ce compte. Tout appel d’API utilisant ces jetons ne pourra pas accéder à l’API.

Autorisations

Sélectionnez les zones de l’API que ce compte a le droit d’utiliser.

API de commande

Pour l’API de commande, choisissez de refuser l’accès, d’autoriser l’accès en lecture seule ou d’autoriser l’accès complet.

API de rapport

Pour la section API de rapport, définissez si ce compte a accès aux rapports et enregistrements de sessions d’assistance technique, aux rapports et enregistrements de sessions de présentation, aux rapports d’utilisation de licences, aux rapports d’archives et aux rapports d’activité de compte Vault.

API de sauvegarde

Définissez si ce compte peut utiliser l’API de sauvegarde.

Configuration de l’API

Définissez si ce compte peut utiliser l’API de configuration et, le cas échéant, si elle peut gérer des comptes Vault.

API d’état en temps réel

Définissez si ce compte peut utiliser l’API d’état en temps réel.

API de gestionnaire d’informations d’authentification de point de terminaison

Définissez si ce compte peut utiliser l’API du gestionnaire d’informations d’authentification de point de terminaison.

Restrictions de réseau

Répertoriez les préfixes d’adresse réseau à partir desquels ce compte peut s’authentifier.

les comptes API ne sont pas restreints par les préfixes réseau configurés sur la page /login > Gestion > Sécurité. Ils sont uniquement restreints par les préfixes de réseau configurés pour le compte d’API.

Liste d’autorisations d’adresses réseau

Saisissez les adresses réseau que vous voulez ajouter à la liste d’autorisations.