Configuration de l’authentification pour les auteurs
Activation de l’authentification pour les auteurs
Par défaut, les auteurs n’ont pas besoin d’être connectés pour utiliser Franklin via Sidekick. Pour activer l’authentification, il suffit d’ajouter des instructions d’accès appropriées à la configuration de votre site. Lorsque vous rencontrez ces instructions d’accès, le Sidekick impose l’authentification auprès du fournisseur correspondant : Microsoft pour les projets basés sur SharePoint et Google pour les projets basés sur Google Drive.
Étape 1 : créer une configuration
S’il n’est pas déjà présent, créez votre fichier de configuration de site :
-
Dans le dossier racine de votre site, créez un dossier nommé
.helix
-
Accédez au dossier nommé
.helix
-
Créez une feuille de calcul avec le nom :
- Sur sharepoint :
config.xlsx
- Sur GDrive :
config
- Sur sharepoint :
-
Nommer le premier en-tête de colonne
key
-
Nommez le deuxième en-tête de colonne.
value
Étape 2 : Ajout De L’Autorisation D’Accès À La Configuration
Ouvrez le fichier de configuration de votre site, situé dans le dossier racine de votre site : .helix/config.xslx
(sur SharePoint) ou .helix/config
(sur GDrive).
Ajouter admin.role.author
et ou admin.role.publish
paires clé/valeur sous forme de lignes vers votre feuille de configuration pour chaque utilisateur ou domaine de caractères génériques pour lequel vous souhaitez donner accès au site.
Exemple pour un utilisateur individuel : admin.role.publish = some.user@example.com
Exemple pour un domaine de caractères génériques : admin.role.author = *@example.com
L’exemple suivant permet à l’auteur d’accéder à tous les utilisateurs du domaine "example.com" et de publier des droits sur un seul utilisateur "some.user@example.com":
Assurez-vous que les utilisateurs peuvent s’authentifier à l’aide de leurs identifiants de connexion comme suit :
- Si vous utilisez Google Drive, ils doivent pouvoir s’authentifier à l’aide de leurs informations d’identification à l’aide de l’authentification Google.
- Si vous utilisez Microsoft SharePoint, ils doivent pouvoir s’authentifier avec leurs informations d’identification à l’aide de l’authentification Microsoft.
Étape 3 : activation de la configuration
Si vous ne l’avez pas déjà fait, installez le Extension Sidekick.
La feuille de configuration du site étant toujours ouverte, cliquez sur le bouton "Aperçu" du Sidekick :
Cette opération copiera la configuration de votre site dans les deux preview
et live
des phases de Franklin, puisque les valeurs de configuration sont traitées globalement.
Étape 4 : connexion via le Sidekick
La prochaine fois que le Sidekick s’ouvre sur un document, une option Se connecter s’affiche :
Une fois que vous avez cliqué dessus, un nouvel onglet du navigateur s’ouvre, redirigeant vers votre fournisseur respectif :
La première fois, il demandera l’autorisation du service d’administration Franklin d’accéder à vos données sharepoint ou google. Si vous n’êtes pas administrateur sur le compte, le message suivant s’affiche :
Dans ce cas, demandez à un administrateur Active Directory de votre organisation de se connecter via Sidekick ou directement via le lien d’administration : https://admin.hlx.page/auth/microsoft
Ils doivent voir les éléments suivants :
L’administrateur peut accorder le consentement directement en cochant la case "Consent on behalf of your organisation
lorsqu’ils se connectent ou plus tard via le portail Azure.
Étape 5 : octroi du consentement de l’administrateur via Azure Portal
Pour accorder le consentement de l’administrateur, ouvrez le portail Azure et accédez à :
Accueil -> Active Directory -> Enterprise Application s
Recherchez le Franklin Admin:
L’ID de l’application doit être indiqué ci-dessus.
Sélectionnez l’onglet Autorisations (sous la sécurité) :
Puis cliquez sur Grant admin consent for {your organisation}
.
Après avoir cliqué sur Accepter , vous pouvez actualiser la variable Autorisations Parfois, jusqu’à ce que les autorisations consenties s’affichent :
Désormais, l’utilisateur non administrateur doit pouvoir se connecter :
Utilisation du service d’administration (admin.hlx.page)
Lorsque l’authentification est activée pour admin.hlx.page
utilisation du point de terminaison API avec des outils tels que curl
nécessite l’utilisation d’un jeton d’authentification approprié. Pour une utilisation ponctuelle par les développeurs, il est très pratique de copier/coller le x-auth-token
en-tête de l’onglet réseau de votre navigateur à partir d’une requête authentifiée envoyée par le sidekick à admin.hlx.page
et transmettez-le dans la variable curl
via le -H
. par exemple :
curl -v -H "x-auth-token: id_token=..." "https://admin.hlx.page/status/[org]/[repo]/main/?editUrl=auto"
Définition des rôles utilisateur sans authentification
Par défaut, dès que le mappage des rôles est défini via un admin.role.*
entrée, l’authentification est appliquée sur ce projet. Il peut être souhaitable d’autoriser un accès non authentifié, mais de pouvoir définir un mappage d’utilisateur, par exemple donner à un utilisateur la valeur admin
rôle.
La variable requireAuth
peut être utilisée à cette fin avec les valeurs suivantes :
auto
est la valeur par défaut et applique l’authentification dès qu’un mappage de rôles est défini.true
fera toujours respecter l’authentificationfalse
n’appliquera pas l’authentification
Exemple :
Donnez à l’utilisateur bob@example.com
la valeur admin
mais n’appliquez pas d’authentification :