Préparer un identifiant Box
01En bref #sec_d80f63df
REVIEWIT collecte une entreprise Box par une application Box que vous créez dans la console développeur de Box, en mode Server Authentication (Client Credentials Grant) . Vous confiez à REVIEWIT trois valeurs : l' Enterprise ID , le Client ID et le Client Secret de cette application. REVIEWIT obtient alors le jeton du compte de service de l'application, valable une heure, et ne fait que lire .
Box n'offre pas de portée « lecture seule » pour l'administration : les portées Manage users ou Manage groups autorisent aussi l'écriture, et l'option as-user permet d'agir au nom d'un utilisateur. REVIEWIT n'en fait qu'un usage en lecture : chaque appel qu'il a le droit de faire est écrit dans le contrat de la ressource, et rien d'autre ne part.
021. Créer l'application #sec_02ac4128
Dans la Box Developer Console ( app.box.com/developers/console ), avec un compte de votre entreprise :
- Create Platform App › Custom App ;
- méthode d'authentification Server Authentication (Client Credentials Grant) ;
- nommez-la, par exemple REVIEWIT Collector .
Pour voir le Client Secret , la vérification en deux étapes doit être activée sur le compte développeur.
032. Régler l'application #sec_9b48a95f
Onglet Configuration :
- App Access Level : App + Enterprise Access . Sans lui, l'application ne voit aucun utilisateur de l'entreprise, et REVIEWIT refuse la connexion.
- Application Scopes , à cocher selon les ressources que vous voulez collecter :
| Portée | Ce qu'elle ouvre à REVIEWIT |
|---|---|
| Read all files and folders stored in Box | Dossiers partagés, collaborations, liens partagés, hubs |
| Manage users | Utilisateurs gérés, administrateurs, collaborateurs externes, utilisateurs d'application |
| Manage groups | Groupes, membres, administrateurs de groupe |
| Manage enterprise properties | Journal d'administration (dernière connexion), domaines autorisés, barrières d'information, liaisons Slack et Teams, hubs de l'entreprise |
| Manage retention policies | Politiques de rétention (Box Governance) |
| Manage legal holds | Conservations légales (Box Governance ; portée sur demande au support Box ) |
- Advanced Features : cochez Make API calls using the as-user header . Le compte de service ne voit que son propre dossier : le contenu de vos utilisateurs se lit en leur nom , en lecture seule.
Une portée que vous ne cochez pas ne bloque pas la connexion : les ressources qui en dépendent restent simplement non collectables , et l'étape Préparer de l'assistant les nomme. Un module que vous n'avez pas souscrit (Box Governance, Box Shield) se lit de même « non souscrit » , jamais « vide ».
043. Faire autoriser l'application par un administrateur #sec_209c1692
Une application Client Credentials Grant ne fonctionne qu' autorisée dans votre entreprise :
- onglet Authorization de l'application › Review and Submit ;
- un administrateur Box : Admin Console › Platform › Platform Apps , l'application soumise › Authorize (ou Add avec son Client ID).
Toute modification des portées ou de l'accès exige une nouvelle autorisation (Platform Apps › … › Reauthorize ) : tant qu'elle n'est pas faite, Box applique l'ancienne configuration.
054. Relever les trois valeurs #sec_6b0a65ee
| Valeur | Où la trouver |
|---|---|
| Enterprise ID | Admin Console › Account & Billing › Account Information (un nombre) ; aussi dans l'onglet General Settings de l'application |
| Client ID | Application › Configuration › OAuth 2.0 Credentials |
| Client Secret | Même endroit ( Fetch Client Secret ) |
Dans REVIEWIT : Connexions › Nouvelle connexion › Box , saisissez les trois valeurs. La vérification :
- obtient le jeton du compte de service ;
- vérifie que ce compte appartient à l'entreprise saisie ;
- vérifie qu'il voit les utilisateurs de l'entreprise ( App + Enterprise Access ).
Puis la preuve des droits constate chaque portée par une lecture minimale : Box ne permet pas à une application de lister ses propres portées.
065. Si la connexion est refusée #sec_28cc585b
| Message de Box | Cause | Geste |
|---|---|---|
| unauthorized_client | L'application n'est pas autorisée dans l'entreprise | Section 3 |
| invalid_grant / invalid_client | Secret faux ou régénéré, ou Enterprise ID qui n'est pas celui de l'autorisation | Recopier le secret, vérifier l'Enterprise ID |
| The grant type is unauthorized | L'application n'est pas en Client Credentials Grant | Créer une application Server Authentication (Client Credentials Grant) |
| the app reaches the enterprise but cannot list its users | App Access Only , ou portée Manage users absente | Section 2, puis réautoriser (section 3) |
| insufficient_scope | Une portée manque | Cocher la portée, puis réautoriser |
Le secret ne change que si vous le régénérez : faites-le à chaque départ d'une personne qui l'a vu, puis remplacez-le dans REVIEWIT.