Dela via


MinimalCsom-Behörighetsplugin

Identifierar minimala behörigheter som krävs för att anropa registrerade API-begäranden för SharePoint Client-Side Object Model (CSOM).

Skärmbild av en kommandorad som visar Dev Proxy med minimal behörighet som krävs för att anropa den inspelade uppsättningen SharePoint CSOM-API:er.

Definition av plugin-instans

{
  "name": "MinimalCsomPermissionsPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "minimalCsomPermissionsPlugin"
}

Konfigurationsexempel

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

Konfigurationsegenskaper

Fastighet Beskrivning Förinställning
typesFilePath Sökväg till filen som innehåller behörigheter som krävs för att anropa SharePoint CSOM-API:er ~appFolder/config/spo-csom-types.json

Kommandoradsalternativ

Ingen

Anmärkningar

Plugin-programmet MinimalCsomPermissionsPlugin identifierar vilka behörigheter klientprogrammet minst behöver för att anropa uppsättningen med SharePoint CSOM-API:er. För att identifiera dessa minimala behörigheter använder plugin-programmet information om behörigheter för SharePoint CSOM-API:er som finns i den angivna filen med SharePoint CSOM-typer.

Fil med SharePoint CSOM-typer

MinimalCsomPermissionsPlugin Använder en CSOM-typfil för att avgöra vilka minimala behörigheter klientprogrammet behöver för att anropa den specifika uppsättningen CSOM-API:er. Filen CSOM-typer är en JSON-fil som innehåller information om SharePoint CSOM-typer och deras behörigheter. I följande exempel visas en exempelfil med CSOM-typer:

{
  "$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": [
      ]
    }
  }
}

Filen består av tre huvuddelar:

  • types
  • returnTypes
  • actions

Avsnittet types innehåller en lista över SharePoint CSOM-typer och deras ID:n. Det här avsnittet ingår för läsbarhet eftersom det är lättare att förstå Microsoft.SharePoint.Client.RequestContext.Current än 3747adcd-a3c3-41b9-bfab-4a64dd2f1e0a.Current.

Avsnittet returnTypes innehåller en lista över returtyper för metoderna i actions avsnittet. Plugin-programmet använder den här informationen när du parsar CSOM-begäranden för att korsa hierarkin för CSOM-API:erna.

Avsnittet actions innehåller en lista över åtgärder som kan utföras med SharePoint CSOM-API:er. För varje åtgärd visas de delegerade behörigheter och programbehörigheter som ett klientprogram kan använda för att utföra den här åtgärden. Behörigheterna sorteras stigande efter deras behörighet, så att de minst privilegierade behörigheterna visas först.

Från och med idag är filen med CSOM-typer som vi inkluderar med Dev Proxy ofullständig. Vi arbetar tillsammans med vår community för att dokumentera fler typer. Under tiden kan du uppdatera den så att den innehåller de typer och behörigheter som du behöver om den information som du behöver saknas. Du kan sedan använda din egen typfil. Vi rekommenderar att du bidrar med dina ändringar tillbaka till communityn så att vi alla kan dra nytta av dem genom att skapa en pull-begäran i dev proxy-exempellagringsplatsen. Vi hämtar regelbundet de senaste ändringarna från lagringsplatsen till Dev Proxy-lagringsplatsen så att du kan dra nytta av de senaste ändringarna utan att behöva uppdatera dev proxy-installationen.