Configuration de l’API : Activation de l’API XML et configuration de champs personnalisés
Gestion
Configuration de l’API
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.
Téléchargement de Client CLI
L’outil d’interface de ligne de commande (CLI) 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 Privileged Remote Access. 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.
Pour plus d’informations sur la création d’API, consultez les exemples de Cas d’utilisation du Guide de l’API BeyondTrust Privileged Remote Access .
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 un compte d’API, 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.
Commentaires
Ajoutez des commentaires pour aider à identifier la fonction de cet objet.
Identifiant client OAuth
L’ID client OAuth est un identificateur unique généré par l'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.
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 peut pas accéder à l’API.
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.
Pour plus d’informations, veuillez consulter le Guide de l’API.
Autorisations
Sélectionnez les zones de l’API que ce compte a le droit d’utiliser. 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. Définissez également si ce compte peut utiliser l’API de rapport, l’API de sauvegarde, l’API de configuration et/ou l’API du gestionnaire d’informations d’authentification de point de terminaison.
L’API de configuration permet de gérer et de configurer des tâches fréquentes dans /login, ce processus pouvant être automatisé et étant compatible avec vos processus d’orchestration.
L’API SCIM permet l’approvisionnement d’utilisateurs d’un fournisseur de sécurité différent. En autorisant l’accès à l’API SCIM, l’option Autoriser un jeton du porteur à long terme devient disponible. Autoriser les jetons à long terme n’est pas recommandé, à moins que cela ne soit requis par votre client SCIM, étant donné que ces jetons du porteur n’expirent jamais. Comme toutes les autres autorisations de l’API exigent des jetons expirant au bout d’une heure, activer les jetons à long terme pour SCIM désactive toutes les autres autorisations de l’API.
Pour plus d’informations, veuillez consulter la section API de configuration d’un compte Vault.
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.
Groupes ECM
cette fonction est présente uniquement si elle est activée lorsque votre site est créé. Si elle n’est pas disponible, veuillez contacter l’administrateur de votre site.
La fonction Groupes ECM fournit la prise en charge pour plusieurs fournisseurs d’informations d’authentification déconnectés. Elle permet un déploiement PRA unique pour effectuer une intégration avec plusieurs fournisseurs d’informations d’authentification externes comme Password Safe ou Privileged Identity. Ceux-ci peuvent se trouver en divers emplacements distants via plusieurs serveurs ECM.
Nom du nouveau groupe ECM
Créez un nom unique permettant d’identifier ce groupe ECM. Vous pouvez configurer jusqu’à cinquante groupes ECM.
