Partages et jeton d’accès personnel

Les Jetons d’accès personnels sont des codes d’accès à l’API publique de Gandi que vous pouvez générer plus « finement » que la Clé API disponible dans le compte utilisateur. Ces jetons vous permettent de donner l’accès à une organisation seulement, voire uniquement à certains produits d’une organisation.

Important

Les permissions procurées par un Jeton d’accès personnel n’impactent QUE les requêtes via l’API publique de Gandi. Un jeton d’accès personnel n’a aucun effet sur les accès via l’interface web d’administration Gandi.

L’écran Partage

L’écran Partage du menu ORGANISATION affiche par défaut tous les Partages des produits liés à une organisation spécifique, qu’il s’agisse des partages autorisés via les Équipes ou ceux permis par les **Partages** (Quickshare) sur les produits.

Pour vous rendre à cet écran, suivez les instructions ci-dessous :

  1. Connectez-vous à votre compte Gandi, puis rendez-vous dans la rubrique « ORGANISATIONS ».

  2. Cliquez sur le nom de l’organisation que vous voulez gérer (ou cliquez sur le bouton « Gérer »).

  3. Cliquez sur l’onglet « Partage » dans le menu en haut de l’écran.

Les détails de toutes les permissions existantes pour cette organisation seront affichées sur cette page. Celles procurées par un Jeton d’accès personnel seront visibles via un logo API affiché à côté de l’utilisateur qui a généré ledit jeton.

Tous les jetons sont effaçables à partir de cette page. Un jeton effacé supprime immédiatement tous les droits liés à celui-ci.

Détails

Le premier tableau correspond aux permissions données sur l’ensemble de l’organisation, soit via les équipes, soit via un Jeton d’accès personnel. La colonne Utilisateur donne le nom de l’utilisateur qui possède les permissions telles que décrites dans la colonne Permissions. Enfin, Équipes vous renseigne sur l’équipe qui est concernée pour cet utilisateur et ces permissions.

Les Jetons d’accès personnels ne possèdent pas d’équipe et sont marqués par un logo API.

Si vous avez les permissions suffisantes, vous pourrez modifier ces Équipes directement via le bouton « Gérer les équipes », sinon vous n’aurez que la possibilité de « Voir les équipes ».

Les tableaux suivants concernent les partages par produits, donc soit via le Partage, soit via un Jeton d’accès personnel restreint (voir ci-dessous).

Enfin, tout en bas de la page, vous trouverez le bloc Jeton d’accès personnel (PAT) vous permettant de créer un jeton (et de consulter la documentation sur l’API publique).

Jetons d’accès personnel

Contrairement aux clés API qui donnait un accès unique à tous les produits de toutes les organisations d’un utilisateur pour une durée indéterminée et qui pouvait être donné à plusieurs personnes, un Jeton d’Accès Personnel a :

  • une durée limitée,

  • des permissions limitées (ou non) sur les produits d’une organisation ou sur une liste de produits en particulier,

  • peuvent être multiples, nommés et donc « nominatif »

Les Jetons d’Accès Personnel (ou PAT en anglais) vous permettent d’améliorer la sécurité et la gestion des accès à vos produits via l’API publique Gandi.

Créer un jeton

Note

Vous pouvez créer un jeton depuis l’écran « Partage » de vos organisations, ou depuis les « Paramètres Utilisateur » (menu déroulant en haut à droite, à partir de votre identifiant).

Pour créer un jeton, suivez les instructions données plus haut pour vous rendre sur la page Partages de l’organisation à laquelle vous avez besoin de données des accès, et cliquez sur le bouton « Créer un jeton » dans le bloc Jeton d’accès personnel (PAT) dans le bloc tout en bas de cette page.

Vous arriverez sur le formulaire de création de jeton. Pour créer le jeton, remplissez les différents champs :

Nom du jeton d’accès personnel

C’est un nom libre de choix qui vous permettra de retrouver facilement le jeton concerné dans la liste (page des Partages). Évitez les noms trop longs, les caractères spéciaux ou accentués.

Expire dans

Ce réglage (obligatoire) permet de donner une « durée de vie » à votre jeton. Une fois ce délai passé, le jeton expirera de lui-même et ne sera plus utilisable. Les durées disponibles sont, pour le moment, de 7 jours, 30 jours, 60 jours, 90 jours ou 1 an.

Ressources du jeton d’accès

Les « Ressources » définissent les éléments auxquels l’utilisateur du Jeton aura accès (via l’API uniquement).

  • L’organisation complète : signifie qu’il aura accès à tous les produits liés à cette organisation : Noms de domaines et leurs services (mail, redirections, etc.), certificats SSL et les différents types d’hébergement.

  • Restreint aux produits sélectionnés : en sélectionnant cette option, vous aurez un menu déroulant dans lequel vous pourrez chercher et sélectionner des produits parmi la liste de ceux appartenant à l’organisation. Chaque produit ajouté apparaît sous forme d’une étiquette dans la liste. Vous pouvez supprimer un produit ajouté via l’icône x situé à sa droite.

Permissions allouées au jeton d’accès

Ce sont les permissions existantes que vous pouvez accorder via le Jeton et elles permettront ou au contraire refuserons l’accès à certaines commandes de l’API publique. Elles sont classifiées par « ressources ».

Une fois les différents “champs” du formulaire remplis, cliquez sur « Créer » pour générer le jeton (ou sur « Annuler » pour abandonner l’action).

Jeton généré

Une fois le jeton généré, vous arriverez sur une page vous permettant de conserver ce jeton. Pour cela, utilisez le bouton « Copier », c’est lui qui “déverrouillera” le bouton « Terminé » de la page. C’est ce jeton que vous devrez conserver précieusement (il n’y a aucun moyen de le récupérer) et fournir à la personne qui a besoin d’accéder à votre organisation ou vos produits.

Vous verrez aussi une commande “curl” vous permettant de tester le jeton via un terminal. Il vous suffit de copier cette commande et de la coller dans un terminal avant de la lancer. Si elle affiche une erreur 401 Unauthorized vérifiez que vous n’avez pas fait d’erreur lors du copier-coller ou régénérer un nouveau jeton. Dans le cas contraire, l’API vous renverra le détail des ressources liées à ce jeton.

Si vous avez de plus amples informations ou des questions à poser, n’hésitez pas à contacter le support Gandi

Utiliser un Jeton

Pour utiliser un Jeton vous devrez ajouter un entête à votre requête curl, appelé Authorization, avec pour valeur, votre Jeton, précédé du terme « Bearer ». Plus d’informations ici [EN]

-H 'authorization: Bearer a5f72d8e2b391ca6d7104e8b35f9a01c3d4762f9' \

Remplacez “a5f72d8e2b391ca6d7104e8b35f9a01c3d4762f9” par votre propre Jeton.

Révoquer un Jeton

Vous pouvez révoquer un jeton généré à tout moment :

Depuis l’organisation

  1. Connectez vous à votre compte Gandi, puis rendez-vous dans ORGANISATIONS,

  2. Sélectionnez l’organisation concernée dans la liste, ou cliquez sur Gérez,

  3. Rendez-vous dans l’onglet Partages,

  4. Recherchez le jeton concerné et cliquez sur l’icone Poubelle rouge (🗑). Le jeton sera immédiatement supprimé et les accès révoqués.

Deuis le compte utilisateur Le compte utilisateur reprend l’intégralité de vos jetons, sans « filtrage » par organisation comme ci-dessus. De fait l’affichage peut être un peu plus lent.

  1. Connectez vous à votre compte Gandi,

  2. Rendez-vous dans le compte utilisateur, via votre nom d’utilisateur en haut à droite, ({username} ⋁ )

  3. Dans le menu déroulant, choisissez Paramètres,

  4. Recherchez le bloc intitulé Jetons d’accès personnel (PAT) sur la page,

  5. Cliquez sur Voir mes jetons d’accès personnel,

  6. Recherchez le jeton concerné et cliquez sur l’icone Poubelle rouge (🗑). Le jeton sera immédiatement supprimé et les accès révoqués.