Aller au contenu
Documentation

Authentification et clésAPI

La plateforme accepteAPI Gateway les clésCHAMPREPAPI à portée limitée pour les intégrations de serveurs et l’automatisation. Les sessions de compte via navigateur sont utilisées pour gérer les clés, mais une intégration personnalisée doit authentifier ses requêtes de service à l’aide d’une APIclé.

  1. Ouvrir API Clés.
  2. Choisissez un nom qui identifie la charge de travail et l’environnement.
  3. Pour chaque service, choisissez un niveau d’accès, puis affinez-le pour ne retenir que les périmètres dont la charge de travail a besoin.
  4. Ajoutez une liste blanche d’adresses IP lorsque la charge de travail dispose d’adresses sortantes stables.
  5. Copiez la clé une seule fois et stockez-la dans un gestionnaire de secrets ou un trousseau.

Ne créez pas une seule clé à portée étendue pour chaque application. Des clés distinctes rendent la rotation, l’audit et la réponse aux incidents plus sûrs.

Authorization: Bearer YOUR_API_KEY

Pour les exemples de shell, conservez la valeur dans une variable d’environnement :

Fenêtre de terminal
curl --fail-with-body \
--header "Authorization: Bearer $CHAMPREP_TOKEN" \
https://api.champrep.com/v1/auth/whoami

N’insérez pas de clé dans une URL, un paramètre de requête, un bundle JavaScript front-end, une application mobile, une ligne de journal ou un événement d’analyse.

L’écran « ClésAPI » regroupe les services en quatre domaines : Espace de travail, Communication, Développeur et Administration. Pour chaque service, choisissez un niveau d’accès, puis ajoutez ou supprimez des portées individuelles si la charge de travail nécessite une autorisation plus restreinte :

  • Aucune: la clé ne permet pas d’utiliser le service.
  • Lecture: les champs d’application indiqués dans la colonne « Lecture ».
  • Lecture et écriture: Lecture plus les périmètres indiqués dans la colonne « Écriture ».
  • Administrateur: tout ce qui précède, plus les champs d’application de la colonne « Admin », pour les services qui en disposent.

Portées marquées sur inscription ne sont jamais sélectionnées par niveau. Cochez-les par leur nom. Un service non inclus dans votre forfait apparaît verrouillé, avec un lien vers la mise à niveau. L’écran affiche toujours le catalogue actuellement en ligne.

ServiceLectureÉcritureAdministrateur
Drivedrive:readdrive:write, drive:delete—
Docsdocs:read, docs:exportdocs:write, docs:share, docs:delete—
Feuilles de calculsheets:read, sheets:exportsheets:write, sheets:share, sheets:delete—
Notesnotes:readnotes:write—
Calendarcalendar:readcalendar:write—
Contactscontacts:readcontacts:write—
Workwork:readwork:write, work:delete—
Formsforms:readforms:write—
Invoiceinvoice:readinvoice:write, invoice:send, invoice:delete—
Organigrammescharts:readcharts:write, charts:delete—
Learncourses:readcourses:write—
École LMSPas encore disponible via une cléAPI
ServiceLectureÉcritureAdministrateur
Mailmail:readmail:write, mail:send—
Chatchat:readchat:write—
Meetmeet:readmeet:write—
RTCÀ venir. RTC utilise ses propres clésAPI de projet

ServiceLectureÉcritureAdministrateur
CHAMPREP Codecode:read_api, code:read_repository, code:read_registry, code:read_package_registrycode:write_repository, code:write_registry, code:write_package_registrycode:api; activation requise code:admin_mode
CHAMPREP QAqa:readqa:write—
Ferme de runnersrunner_farm:readrunner_farm:write—
CLI—cli:use—
CHAMPREP AI—ai:chat; activation requise ai:actions, ai:agent—

ServiceLectureÉcritureAdministrateur
Entreprisebusiness:read—business:manage
Facturationbilling:read—billing:manage
Développeur APIapi:read—api:manage, webhooks:manage
Profilusers:read——

L’administration de la plateforme n’est jamais accessible à une cléAPI ; elle nécessite un administrateur connecté.

  • CHAMPREP Code. Chaque code: correspond à celui du jeton d’accès personnel du même nom dans CHAMPREPCode, et Code le vérifie sur chaque point de terminaison. code:api correspond à un accès complet en lecture et en écriture à tout ce que votre compte peut atteindre dans Code ; il se situe donc au niveau « Admin » ; privilégiez les autorisations plus restreintes read_ et write_ . Les points de terminaison d’administration du code nécessitent une clé contenant code:admin_mode par nom, ainsi qu’un compte disposant des droits d’administrateur Code.
  • Ferme de Runner. runner_farm:write enregistre et gère les runners, les pools et les connexions. Il n’achète jamais de crédits ni ne modifie les paramètres de paiement, et il ne génère, ne remplace ni ne teste jamais de secret de connecteur ou de jeton de runner. Ces actions nécessitent une personne connectée.
  • Docs et Sheets. Le partage (collaborateurs, partage de liens, publication), la suppression définitive ou la purge, ainsi que l’exportation nécessitent chacun leur propre champ d’application. Une clé ne comportant que docs:write ou sheets:write peuvent modifier le contenu, mais ne peuvent ni le partager, ni le purger, ni l’exporter.
  • CHAMPREP AI. ai:agent permettent de CLI Agent IA utilisent des outils locaux et incluent ai:chat. ai:actions approuve ou rejette les actions que l’IA propose dans vos CHAMPREPservices, et rien d’autre.

La portée « * » * (accès complet) couvrent tous les services inclus dans votre forfait, y compris CHAMPREPCode, Runner Farm et Docs. CHAMPREPCode les traite comme code:api, ce qui correspond à un accès complet en lecture et en écriture. Cela n’inclut pas ai:agent ou code:admin_mode; celles-ci doivent toujours être sélectionnées par leur nom.

Réservez le caractère générique aux intégrations administratives strictement contrôlées, et limitez les clés d’accès complet existantes si elles n’ont pas besoin des nouveaux services. Une portée autorise une catégorie d’actions ; elle ne remplace pas les autorisations liées au forfait, au rôle, à l’organisation ou à la ressource.

Créez ou régénérez une clé de remplacement, déployez-la, vérifiez que la charge de travail l’utilise, puis révoquez la clé précédente. Évitez toute rotation qui laisserait une charge de travail sans surveillance et dépourvue d’identifiants valides.

Révoquez immédiatement une clé si elle a été exposée, copiée sur un système non fiable ou si elle n’appartient plus à une charge de travail active. Une clé révoquée doit renvoyer 401 et ne doit pas faire l’objet de tentatives indéfinies.

Vérifiez régulièrement les noms de clés, les portées, les restrictions d’adresse IP, les informations relatives à la dernière utilisation et l’activité d’audit. Supprimez les clés inutilisées au lieu de les conserver en vue d’un éventuel script futur.

champrep auth login utilise un processus d’approbation via navigateur pour une personne utilisant un terminal. champrep auth token stocke une APIclé à portée limitée pour l’automatisation. La CLI protègeCLI les identifiants stockés à l’aide du trousseau du système d’exploitation et envoie toutes les commandes réseau via la passerelle.

Voir CLI Authentification et API Clés pour l’automatisationCLI pour ces flux de travail.