API keys
Aperçu
Parfois, vous avez des cas d’utilisation et des exigences que nous ne proposons pas encore. Utilisez les API Qalyptus dans votre workflow pour répondre à vos besoins.
Accédez à la documentation de référence de l'API Qalyptus.
Gestion des clés API
Les clés API sont désactivées par défaut dans votre locataire (tenant) Qalyptus. Toutefois, un administrateur du locataire peut activer les clés API pour tous les utilisateurs ou pour les utilisateurs définis dans des groupes spécifiques.
Pour activer les clés API, procédez comme suit :
- Accédez à Administration > Paramètres.
- Accédez à la section Clés API.
- Cochez Activer les clés API.
- Choisissez si vous souhaitez autoriser tous les utilisateurs du locataire à créer des clés API ou autoriser uniquement les utilisateurs de groupes spécifiques.
- Sélectionnez des groupes dans la liste si vous choisissez la deuxième option.
- Saisissez la période d'expiration de la clé API en jours. La période d'expiration maximale est de 365 jours.
- Cliquez sur Enregistrer.
Désormais, les utilisateurs autorisés peuvent générer des clés API, qui expirent entre un et 365 jours.
Chaque utilisateur autorisé peut générer jusqu'à 1000 clés API.
Si vous désactivez les clés API, les clés API existantes cesseront de fonctionner jusqu'à ce que vous les réactiviez.
Si un utilisateur ne fait plus partie des utilisateurs autorisés, ses clés API existantes cesseront de fonctionner jusqu'à ce qu'il soit dans la liste des utilisateurs autorisés.
Générer des clés API
Les clés API sont des identifiants uniques utilisés pour authentifier les requêtes que vous pouvez effectuer pour gérer vos ressources dans votre locataire Qalyptus. Ils vous permettent d'accéder en toute sécurité à divers points de terminaison de l'API REST et servent de forme d'identification.
Pour générer une clé API, procédez comme suit :
- Accédez à Profil > Clés API.
- Cliquez sur Clé Génération.
- Entrez un nom.
- Ajoutez une description si vous le souhaitez.
- Ajoutez une date d'expiration. Votre administrateur définit la date d'expiration maximale.
- Sélectionnez une organisation. La clé API sera uniquement autorisée à accéder au contenu de l'organisation sélectionnée.
- Cliquez sur Enregistrer.
La clé de licence API apparaîtra. Copiez-la et conservez-la dans un endroit sécurisé, car vous ne pourrez plus la voir.
Vous pouvez désormais utiliser la clé API dans votre système. Visitez la référence de l'API Qalyptus pour voir les points de terminaison disponibles.
Vous pouvez modifier le nom et la description de la clé API après sa création. Cependant, d'autres informations ne peuvent pas être mises à jour.