MinimalCsomPermissionsPlugin

Détecte les autorisations minimales nécessaires pour appeler les demandes d’API sharePoint Client-Side modèle objet (CSOM) enregistrées.

Définition de l’instance de plug-in

{
  "name": "MinimalCsomPermissionsPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "minimalCsomPermissionsPlugin"
}

Exemple de configuration

{
  "minimalCsomPermissionsPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/minimalcsompermissionsplugin.schema.json",
    "typesFilePath": "./api-specs"
  }
}

Propriétés de configuration

Propriété	Descriptif	Par défaut
typesFilePath	Chemin d’accès au fichier qui répertorie les autorisations requises pour appeler des API CSOM SharePoint	~appFolder/config/spo-csom-types.json

Options de ligne de commande

Aucun

Remarques

Le MinimalCsomPermissionsPlugin plug-in détecte les autorisations dont l’application cliente a besoin au minimum pour appeler l’ensemble d’API CSOM SharePoint. Pour détecter ces autorisations minimales, le plug-in utilise des informations sur les autorisations pour les API CSOM SharePoint situées dans le fichier de types CSOM SharePoint spécifié.

Fichier de types CSOM SharePoint

Il MinimalCsomPermissionsPlugin utilise un fichier de types CSOM pour déterminer quelles autorisations minimales l’application cliente doit appeler l’ensemble spécifique d’API CSOM. Le fichier de types CSOM est un fichier JSON qui contient des informations sur les types CSOM SharePoint et leurs autorisations. L’exemple suivant montre un exemple de fichier de types CSOM :

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/minimalcsompermissions.types.schema.json",
  "types": {
    "268004ae-ef6b-4e9b-8425-127220d84719": "Microsoft.Online.SharePoint.TenantAdministration.Tenant",
    "3747adcd-a3c3-41b9-bfab-4a64dd2f1e0a": "Microsoft.SharePoint.Client.RequestContext"
  },
  "returnTypes": {
    "Microsoft.SharePoint.Client.RequestContext.Current.Site": "Microsoft.SharePoint.Client.Site"
  },
  "actions": {
    "Microsoft.SharePoint.Client.RequestContext.Current": {
      "delegated": [
        "AllSites.Read",
        "AllSites.Write",
        "AllSites.Manage",
        "AllSites.FullControl"
      ],
      "application": []
    },
    "Microsoft.SharePoint.Client.Site.setProperty": {
      "delegated": [
        "AllSites.FullControl"
      ],
      "application": []
    },
    "Microsoft.Online.SharePoint.TenantAdministration.Tenant.ctor": {
      "delegated": [
        "AllSites.Read",
        "AllSites.Write",
        "AllSites.Manage",
        "AllSites.FullControl"
      ],
      "application": [
      ]
    },
    "Microsoft.Online.SharePoint.TenantAdministration.Tenant.query": {
      "delegated": [
        "AllSites.Write",
        "AllSites.Manage",
        "AllSites.FullControl"
      ],
      "application": [
      ]
    },
    "Microsoft.Online.SharePoint.TenantAdministration.Tenant.GetSitePropertiesFromSharePointByFilters": {
      "delegated": [
        "AllSites.FullControl"
      ],
      "application": [
      ]
    }
  }
}

Le fichier se compose de trois parties principales :

• types
• returnTypes
• actions

La types section contient une liste de types CSOM SharePoint et de leurs ID. Cette section est incluse pour la lisibilité, car elle est plus facile à comprendre Microsoft.SharePoint.Client.RequestContext.Current que 3747adcd-a3c3-41b9-bfab-4a64dd2f1e0a.Current.

La returnTypes section contient une liste de types de retour pour les méthodes de la actions section. Le plug-in utilise ces informations lors de l’analyse des requêtes CSOM pour parcourir la hiérarchie des API CSOM.

La actions section contient une liste d’actions qui peuvent être effectuées à l’aide d’API CSOM SharePoint. Pour chaque action, elle répertorie les autorisations déléguées et d’application qu’une application cliente peut utiliser pour effectuer cette action. Les autorisations sont triées par ordre croissant par leur privilège, afin que les autorisations les moins privilégiées soient répertoriées en premier.

À compter d’aujourd’hui, le fichier de types CSOM que nous incluons avec le proxy de développement est incomplet. Nous travaillons ensemble avec notre communauté pour documenter d’autres types. Pendant ce temps, vous pouvez la mettre à jour pour inclure les types et autorisations dont vous avez besoin si les informations dont vous avez besoin sont manquantes. Vous pouvez ensuite utiliser votre propre fichier de types. Nous vous encourageons à apporter vos modifications à la communauté afin que nous puissions tous en tirer parti, en créant une demande de tirage dans le référentiel d’exemples du proxy de développement. Nous extrayons régulièrement les dernières modifications du référentiel vers le référentiel du proxy de développement afin que vous puissiez tirer parti des dernières modifications sans avoir à mettre à jour votre installation du proxy de développement.