Passer au contenu principal

Comment gérer vos clés API (On Premise, SCIM, API Publiques)

Découvrez comment gérer des clés API pour : la synchronisation On Premise, le provisionning SCIM, ou l'utilisation de nos API Publiques.

D
Écrit par Dalia ABEL
Mis à jour cette semaine

Cette opération nécessite la présence d'un administrateur de votre tenant Office 365.

Les clés API vous permettent de connecter de manière sécurisée des applications ou des systèmes tiers à Letsignit, sans passer par l’interface utilisateur.

1 - Création d'une clé API :

  • Dans un premier temps, nous vous invitons à vous rendre sur la page "API", accessible depuis le menu "Settings" :

  • Cliquez sur "Créer une Clé"

  • Nommez la clé

  • Sélectionnez le scope qui vous intéresse :

    • SCIM (pour le provisionning automatique depuis Entra ID) : plus de détails ici

    • On Premise

    • API Publique

  • Cliquer sur "Créer"

  • Pensez ensuite à copier la clé secrète qui est affichée, car elle ne sera plus copiable une fois la fenêtre fermée.

1.1 Particularités pour les clés API SCIM

Si vous sélectionnez le scope "SCIM" lors de la création d'une clé, vous avez la possibilité d'activez ou non les attributs personnalisés SCIM.

  • Cette activation/désactivation sera modifiable également par la suite, depuis le listing des clés API, au niveau des paramètres de la clé :

  • Si vous créez plusieurs clés API avec le scope SCIM, l'activation/désactivation des attributs personnalisés SCIM sera commun

1.2 Particularités pour les clés API On Premise

Si vous sélectionnez le scope "On Premise" lors de la création d'une clé, vous aurez la possibilité :

  • D'autoriser votre script à récupérer les signatures Letsignit

  • D'autoriser votre script à envoyer les informations de votre AD vers Letsignit

Ces options seront modifiables également par la suite, depuis le listing des clés API, au niveau des paramètres de la clé.

2 - Révoquer une clé API

Pour des raisons de sécurité (clé compromise, accès à limiter, utilisateur non autorisé, etc.), vous pouvez révoquer une clé API à tout moment.

🔐 Qu'est-ce que cela signifie ?

Révoquer une clé API signifie la désactiver de façon permanente.

Une fois révoquée :

  • La clé ne pourra plus être utilisée pour authentifier des requêtes.

  • Toute tentative d’appel avec cette clé renverra une erreur d’autorisation (généralement 401 ou 403).

🛠️ Comment révoquer une clé ?

  • Sur la page API, cliquer sur les 3 points de la colonne "Actions" correspondants à la clé API que vous voulez révoquer :

  • Cliquez sur "Révoquer"

  • Confirmez en cliquant sur "Révoquer définitivement"

3 - Expiration d'une clé API

Chaque clé API que vous créez est valable pendant 1 an à compter de sa date de création.

📬 Notification avant expiration

Pour éviter toute interruption de service :

  • L'admin global du tenant recevra un email de notification 1 mois avant l’expiration de chaque clé.

  • Pensez à générer une nouvelle clé à temps et à mettre à jour vos intégrations.

🚫 Ce qui se passe après expiration

  • Une clé expirée devient inutilisable : toute requête faite avec celle-ci sera rejetée.

  • Sur le listing des clés API, la clé est affichée comme "Expirée" (pastille rouge).

  • Un message d’information vous indique que la clé sera automatiquement supprimée 3 mois après sa date d’expiration.

Pour vos équipes de développements qui souhaitent la documentation de nos API Publiques, voici le lien

Avez-vous trouvé la réponse à votre question ?