Intégrations

Connecteurs sociaux

Permettre aux utilisateurs de se connecter à votre site avec un compte Google, GitHub, Office 365 ou un autre fournisseur OAuth, grâce à une Clé de connexion sociale.

Connecteurs sociaux

Une Clé de connexion sociale ajoute un bouton « Connexion avec … » sur la page de connexion de votre site. L'utilisateur s'identifie chez le fournisseur (Google, GitHub, Office 365…), puis revient connecté sur votre site.

Pour l'inverse (autoriser une application externe à utiliser votre site comme fournisseur), consultez OAuth.

Prérequis

  • Avoir le rôle Responsable système.
  • Avoir créé une application OAuth chez le fournisseur, pour obtenir un ID client et un Secret client.

Configurer un fournisseur

  1. Ouvrez la recherche (Ctrl+K) et saisissez Clé de connexion sociale. Le document se trouve aussi dans l'espace Intégrations, section Authentification.
  2. Cliquez sur Créer.
  3. Choisissez le Fournisseur de connexion sociale : Facebook, Dodock, GitHub, Google, Office 365, Salesforce, fairlogin, Keycloak ou Custom. Pour un fournisseur connu, Dokos remplit les URL et l'URL de Redirection.
  4. Saisissez le Nom du fournisseur. Il s'affiche sur le bouton de connexion.
  5. Saisissez l'ID client et le Secret client donnés par le fournisseur.
  6. Chez le fournisseur, déclarez l'URL de retour : l'adresse de votre site suivie de l'URL de Redirection.
  7. Cochez Activer la connexion sociale, puis enregistrez.

Le bouton n'apparaît sur la page de connexion que si l'ID client, l'URL de base et le Secret client sont renseignés.

Champs principaux

ChampRôle
Activer la connexion socialeAffiche le bouton sur la page de connexion. L'ID client est alors obligatoire.
Fournisseur de connexion socialeModèle de configuration. Custom laisse toutes les URL à saisir.
Nom du fournisseurTexte du bouton. Le nom du document en est dérivé. Obligatoire.
ID client / Secret clientIdentifiants de l'application créée chez le fournisseur.
IcôneIcône du bouton, pour un fournisseur Custom.
URL de baseAdresse du fournisseur. Obligatoire.
URL d'authorisation / URL du jeton d'accèsPoints de terminaison OAuth du fournisseur. Obligatoires.
URL de RedirectionChemin de retour sur votre site. Obligatoire.
API EndpointPoint de terminaison qui renvoie le profil de l'utilisateur.
Args de paramètres API / Données d'URL d'authentificationParamètres supplémentaires, au format JSON.
Propriété de l'ID utilisateurAttribut du profil qui identifie l'utilisateur, pour un fournisseur Custom.
InscriptionsAutoriser ou Refuser la création d'un compte à la première connexion. Vide : le réglage d'inscription du site s'applique.

URL de retour des fournisseurs connus

FournisseurURL de Redirection
Google/api/method/frappe.integrations.oauth2_logins.login_via_google
GitHub/api/method/frappe.integrations.oauth2_logins.login_via_github
Office 365/api/method/frappe.integrations.oauth2_logins.login_via_office365
Facebook/api/method/frappe.integrations.oauth2_logins.login_via_facebook
Dodock/api/method/frappe.integrations.oauth2_logins.login_via_frappe
Salesforce/api/method/frappe.integrations.oauth2_logins.login_via_salesforce
fairlogin/api/method/frappe.integrations.oauth2_logins.login_via_fairlogin
Keycloak/api/method/frappe.integrations.oauth2_logins.login_via_keycloak

Exemple

Exemple fictif. Votre site est https://atelier-exemple.dokos.cloud. Vos salariés ont un compte Google Workspace.

  1. Dans Google Cloud, créez un ID client OAuth de type « Application Web ».
  2. Déclarez l'URL de retour https://atelier-exemple.dokos.cloud/api/method/frappe.integrations.oauth2_logins.login_via_google.
  3. Dans Dokos, créez une Clé de connexion sociale avec le fournisseur Google et le nom « Google ».
  4. Collez l'ID client et le secret, réglez Inscriptions sur Refuser, cochez Activer la connexion sociale et enregistrez.

La page de connexion affiche « Connexion avec Google ». Seuls les salariés qui ont déjà un utilisateur dans Dokos peuvent se connecter.

Réagir à une connexion depuis une application

Une application peut exécuter du code à chaque connexion sociale, par exemple pour attribuer des rôles à partir des données du fournisseur ou pour refuser la connexion. Ce travail relève du développement : il passe par le hook on_social_login, décrit dans la Référence des hooks.