Frappe Framework
Configurer OAuth 2
Des applications tierces accèdent aux ressources selon les rôles Frappe. Le fournisseur se règle dans OAuth Provider Settings et OAuth Client.
Rôles
Un fournisseur OAuth 2.0, fondé sur oauthlib, est intégré à Frappe. Une application tierce accède aux ressources selon les rôles et les permissions. Quatre rôles :
| Rôle | Sens |
|---|---|
| Propriétaire de la ressource | Autorise l’accès. Si c’est une personne, c’est l’utilisateur final. |
| Serveur de ressource | Héberge les ressources et répond aux requêtes munies d’un jeton. |
| Client | Demande les ressources au nom du propriétaire, avec son autorisation. Le mot ne dit pas si l’application tourne sur un serveur ou un poste. |
| Serveur d’autorisation | Émet les jetons après authentification et autorisation. |
Confirmation
Un System Manager règle le message de confirmation dans Setup > Integrations > OAuth Provider Settings : Force ou Auto. Force demande toujours la confirmation. Auto ne la demande que s’il n’existe pas de jeton actif pour l’utilisateur.
Serveur principal
C’est le serveur qui héberge les utilisateurs, par exemple https://frappe.io. Dans Setup > Integrations > Social Login Key, ajoutez une clé Frappe et saisissez cette adresse dans Base URL. Les autres serveurs Frappe qui s’authentifient ici répètent cette URL. C’est le fournisseur d’identité. Ajoutez-y autant de clients OAuth que nécessaire. La fiche est détaillée dans Social Login Key.
Client
Dans Setup > Integrations > OAuth Client :
- App Name, par exemple CAVS.
- Skip Authorization : pas de message de confirmation. Le client est traité comme un client de confiance.
- Scopes : liste montrée avec la confirmation, séparée par des espaces.
- Redirect URIs : liste séparée par des espaces.
- Default Redirect URI : l’une de ces URI.
- Grant Type : Authorization Code ou Implicit.
- Response Type : Code si le type d’octroi est Authorization Code, sinon Token.
L’usage dans les requêtes est dans OAuth 2.
Point d’attention
Skip Authorization supprime la confirmation. Auto la saute seulement lorsqu’un jeton est déjà actif. Response Type doit suivre le Grant Type indiqué.