Créer ou mettre à jour des ID client et des secrets dans l’Espace partenaires

  • Article

Avertissement

Le service de gestion des ID client SharePoint passe par une modification critique. Vous aurez besoin d’un locataire Microsoft Azure AD/Entra pour continuer à utiliser le service sans interruption après le 1er mars 2023. Accédez aux paramètres du locataire dans votre compte Espace partenaires et créez un ID Entra ou associez votre ID actuel pour continuer à utiliser le service.

Pour mettre à jour les secrets client arrivant à expiration dans les compléments SharePoint

  1. Générez et ajoutez une nouvelle clé secrète client dans l’Espace partenaires pour l’associer à cet ID client de complément particulier. Pour obtenir des étapes spécifiques, consultez Pour générer des secrets clients supplémentaires dans Mettre à jour la clé secrète client associée à votre ID client plus loin dans cet article.
  2. Mettez à jour votre application web distante pour utiliser la nouvelle clé secrète client. Pour plus d’informations sur la façon de procéder à l’aide des outils de développement Microsoft Office pour Visual Studio, consultez Mettre à jour l’application web distante dans Visual Studio pour utiliser le nouveau secret dans Remplacer une clé secrète client arrivant à expiration dans un complément SharePoint.
  3. Republiez votre application web distante.

Important

Microsoft Office Developer Tools pour Visual Studio prend en charge la définition d’une clé secrète client secondaire que vous pouvez utiliser pour mettre à jour votre clé secrète client arrivant à expiration.

Utilisation d’OAuth pour authentifier et autoriser des compléments

Open Authorization (OAuth) est un protocole d'autorisation ouvert. OAuth permet une autorisation sécurisée à partir des applications de bureau et web de manière simple et standard. Il permet aux utilisateurs d’approuver une application pour agir en leur nom sans partager leur nom d’utilisateur et leur mot de passe. Par exemple, les utilisateurs peuvent partager leurs ressources ou données privées (liste de contacts, documents, photos, vidéos, etc.) qui sont stockés sur un site avec un autre site, sans avoir à fournir leurs informations d’identification (généralement le nom d’utilisateur et le mot de passe).

Avec OAuth, les utilisateurs peuvent autoriser un fournisseur de services (par exemple, SharePoint) à fournir des jetons au lieu d’informations d’identification (par exemple, nom d’utilisateur et mot de passe) à leurs données hébergées par un fournisseur de services donné (par exemple, SharePoint). Chaque jeton accorde l’accès à un site spécifique (par exemple, un référentiel de documents SharePoint), pour des ressources spécifiques (par exemple, des documents d’un dossier) et pendant une durée définie. Les utilisateurs peuvent ensuite accorder à un site tiers l’accès aux informations stockées avec un autre fournisseur de services (par exemple, SharePoint), sans partager leur nom d’utilisateur et leur mot de passe et sans partager toutes les données qu’ils ont sur SharePoint.

Si votre complément nécessite ce type d’autorisation, vous devez associer l’ID client OAuth et les secrets clients à votre complément. Vous pouvez générer des secrets client OAuth dans l’Espace partenaires, puis les ajouter à votre code de complément.

Lorsqu’un utilisateur installe un complément qui a un ID client associé et une clé secrète client, une boîte de dialogue de consentement s’affiche. Si l’utilisateur donne son consentement, le complément peut agir au nom de l’utilisateur pour accéder aux données requises par le complément. Les utilisateurs peuvent uniquement accorder les autorisations dont ils disposent. Les octrois représentent les autorisations qu’un utilisateur a déléguées à un complément.

Par exemple, votre complément peut être un complément de calendrier de voyage qui s’ouvre en tant que IFRAME sur un site SharePoint Microsoft 365. OAuth permet au complément d’identifier l’utilisateur auquel appartient le calendrier des voyages, ou si le complément de calendrier de voyage doit accéder à d’autres aspects de Microsoft 365, tels que les ressources ou les informations de calendrier, il peut accéder à ceux-ci pour le compte de l’utilisateur connecté.

Remarque

Pour plus d’informations sur OAuth, l’ID client et les secrets clients, consultez Autorisation et authentification des compléments SharePoint, Flux OAuth de jeton de contexte pour les compléments SharePoint et Inscrire des compléments SharePoint 2013.

Ajouter un ID client et un secret client

Vous ne pouvez associer qu’un seul ID client à votre complément, mais vous pouvez associer plusieurs secrets clients à un ID client. À des fins de sécurité et d’administration, nous vous recommandons de limiter le nombre de secrets clients associés à un ID client.

Important

Pour envoyer un complément SharePoint qui utilise OAuth et le distribuer en Chine, vous devez :

  • Utilisez un ID client et un secret client distinctes pour la Chine.
  • Ajoutez un package de complément distinct spécifiquement pour la Chine.
  • Bloquer l’accès pour tous les pays/régions à l’exception de la Chine.
  • Créez une liste de compléments distincte pour la Chine.

Pour plus d’informations sur la distribution de compléments en Chine, consultez Envoyer des applications pour Office 365 gérés par 21Vianet en Chine.

Les données entrantes de votre complément sont signées à l’aide d’une seule clé secrète client de signature. Dans l’Espace partenaires, il s’agit de la clé secrète client avec une coche verte en regard d’Active dans la colonne État de la page ID client. Si vous supprimez la clé secrète client de signature utilisée par votre complément, la clé secrète client valide suivante est utilisée à la place.

Votre complément peut utiliser n’importe quelle clé secrète client valide comme mot de passe pour communiquer avec Microsoft. Lorsqu’une clé secrète client expire, elle ne peut plus être utilisée comme mot de passe. S’il n’existe qu’une seule clé secrète client associée à votre ID client, la suppression de ce secret peut empêcher votre complément d’accéder aux données dont il a besoin.

Si votre complément est un service et qu’il a besoin d’ID client OAuth et de secrets clients, procédez comme suit.

Pour ajouter un ID client

  1. Connectez-vous à l’Espace partenaires avec votre compte de développeur et accédez à la page Vue d’ensemble du produit de votre complément.

  2. Sous l’onglet ID client, sélectionnez Ajouter un nouvel ID client.

  3. Dans la boîte de dialogue Nouvel ID client, indiquez les informations suivantes.

    Article Informations à fournir
    Nom convivial Sélectionnez un nom pour vous aider à reconnaître le complément qui utilisera cet ID client ; par exemple, « application calendrier »
    Domaine d'application Indiquez le domaine sur lequel votre complément s’exécutera. Par exemple : app.contoso.com.
    Il doit s’agir d’un nom de domaine valide que vous possédez ; il ne doit pas inclure http:// ou https://,
    et il ne doit pas s’agir d’un nom de domaine international
    Ajouter une URL de redirection Indiquez l’URL de redirection vers laquelle envoyer les utilisateurs une fois qu’ils acceptent les exigences d’accès de votre complément dans la boîte de dialogue de consentement.
    Cette URL doit commencer par https://, http://ou ms-app://

  4. Sélectionnez Créer un secret maintenant.

  5. Choisissez la durée pendant laquelle votre clé secrète client sera valide. Les options sont un, deux ou trois ans. Nous vous recommandons de choisir un an, car cela peut être plus facile à suivre dans vos processus métier que sur des périodes plus longues. Toutefois, il n’y a aucun impact sur la sécurité en choisissant deux ou trois ans. Lorsque la clé secrète client arrive à expiration, vous devez mettre à jour votre complément.

  6. Sélectionnez la disponibilité de la clé secrète client. Sélectionnez l’un des suivants :

    • Cet ID client sera utilisé pour une application disponible dans le monde entier.
    • Cet ID client sera utilisé pour une application disponible en Chine uniquement.

  7. Sélectionnez Créer un secret maintenant.

  8. Dans la page Obtenir la clé secrète client, copiez votre ID client et votre clé secrète client vers un emplacement sécurisé afin que vous puissiez y faire référence ultérieurement.

    Important

    La clé secrète client est associée à votre ID client, mais elle ne sera plus affichée dans l’Espace partenaires. Vous devez également enregistrer les dates de début et de fin afin de connaître la période de validité de la clé secrète client et sa date d’expiration. Si votre clé secrète client est proche de l’expiration, vous devez générer une nouvelle clé secrète client et mettre à jour votre complément. Pour plus d’informations, consultez Mettre à jour la clé secrète client associée à votre ID client.

  9. Cliquez sur Terminé.

Mettre à jour la clé secrète client associée à votre ID client

Mettez à jour votre clé secrète client dans les situations suivantes :

  • Votre clé secrète client arrive à expiration

    Nous vous recommandons d’ajouter une nouvelle clé secrète client dans l’Espace partenaires alors que votre clé secrète client actuelle est toujours valide. Mettez à jour votre complément avec la nouvelle clé secrète client, puis supprimez la clé secrète client proche de l’expiration en choisissant Supprimer en regard de cette entrée dans la page ID client de l’Espace partenaires.

    Remarque

    Microsoft Office Developer Tools pour Visual Studio prend en charge la définition d’une clé secrète client secondaire que vous pouvez utiliser pour mettre à jour votre clé secrète client arrivant à expiration.

  • La sécurité de votre clé secrète client est compromise

    Pour répondre rapidement à une compromission de sécurité, vous pouvez d’abord supprimer la clé secrète client compromise de l’Espace partenaires, ajouter une nouvelle clé secrète client, puis mettre à jour votre complément avec la nouvelle clé secrète client.

    Important

    Une fois la clé secrète client compromise supprimée et avant l’ajout de la nouvelle clé secrète client, votre complément peut être temporairement indisponible. Cela peut être acceptable en fonction de la gravité de l’impact commercial d’une clé secrète client perdue ou volée.

Pour générer des secrets clients supplémentaires

  1. Connectez-vous à l’Espace partenaires avec votre compte de développeur et accédez à la page Vue d’ensemble du produit de votre complément.

  2. Sous l’onglet ID client, sélectionnez l’ID client auquel vous souhaitez associer des secrets clients supplémentaires.

  3. Dans la page de détails de l’ID client, sélectionnez Nouvelle clé secrète client.

  4. Choisissez la durée pendant laquelle vous souhaitez que le secret soit valide. Les options sont un, deux ou trois ans.

  5. Sélectionnez Créer.

  6. Copiez la clé secrète client affichée dans la boîte de dialogue Obtenir la clé secrète client vers un emplacement sécurisé afin de pouvoir y faire référence ultérieurement.

    Important

    La clé secrète client est associée à votre ID client, mais elle ne sera plus affichée dans l’Espace partenaires. Enregistrez les dates de début et de fin afin de connaître la période de validité de la clé secrète client et sa date d’expiration.

  7. Sélectionnez Terminé.

    Remarque

    La nouvelle clé secrète client est active dans les 15 minutes.

Pour supprimer une clé secrète client

  1. Connectez-vous à l’Espace partenaires avec votre compte de développeur et accédez à la page Vue d’ensemble du produit de votre complément.

  2. Sous l’onglet ID client, sélectionnez Supprimer en regard de l’ID client qui a la clé secrète client que vous souhaitez supprimer.

    Important

    La suppression d’une clé secrète client peut empêcher votre complément d’accéder aux données dont il a besoin, sauf si vous avez créé des secrets supplémentaires valides et associés à votre complément, et que vous l’avez configuré pour utiliser ces secrets clients supplémentaires. Si vous n’avez qu’une seule clé secrète client associée à l’ID client, nous vous recommandons de générer une clé secrète client supplémentaire avant de la supprimer.

  3. Dans la boîte de dialogue Confirmation, sélectionnez Supprimer.

Supprimer un ID client

Vous pouvez supprimer un ID client dans certaines situations, par exemple :

  • Vous ne souhaitez plus proposer votre complément.
  • Vous souhaitez proposer une nouvelle version de votre complément et ne souhaitez plus proposer la version précédente. Dans ce cas, vous pouvez supprimer l’ID client que vous avez associé à la version précédente de votre complément.

Avertissement

La suppression d’un ID client associé à votre complément supprime tous les secrets clients associés et l’empêche d’accéder aux données dont il a besoin. Tout client qui utilise votre complément subit un temps d’arrêt après la suppression d’un ID client associé.

Supprimer un ID client

  1. Connectez-vous à l’Espace partenaires avec votre compte de développeur et accédez à la page Vue d’ensemble du produit de votre complément.
  2. Sous l’onglet ID client, sélectionnez Supprimer en regard de l’ID client qui a la clé secrète client que vous souhaitez supprimer.
  3. Dans la boîte de dialogue Confirmation, sélectionnez Supprimer.

Pour supprimer un ID client, mais continuer à proposer votre complément

  1. Ajoutez un autre ID client et au moins une clé secrète client valide. Pour plus d’informations, consultez Ajouter un ID client et une clé secrète client.

  2. Supprimez l’ID client de votre code.

  3. Supprimez l’ID client de l’Espace partenaires, comme décrit dans la procédure précédente.

  4. Ajoutez le nouvel ID client et la clé secrète client à votre code.

  5. Dans la page Vue d’ensemble du produit, choisissez Publier.

    Remarque

    Les clients qui utilisent votre complément rencontreront des temps d’arrêt pendant la mise à jour de votre code et le processus d’approbation de l’Espace partenaires.

Voir aussi