Sdílet prostřednictvím


MinimalCsomPermissionsPlugin

Detekuje minimální oprávnění potřebná k volání zaznamenaných požadavků rozhraní API Client-Side objektového modelu služby SharePoint (CSOM).

Snímek obrazovky příkazového řádku s výpisem minimálních oprávnění potřebných k volání zaznamenané sady rozhraní SHAREPoint CSOM API

Příklad konfigurace

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "MinimalCsomPermissionsPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "minimalCsomPermissionsPlugin"
    }
  ],
  "minimalCsomPermissionsPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/minimalcsompermissionsplugin.schema.json",
    "typesFilePath": "./api-specs"
  }
}

Vlastnosti konfigurace

Vlastnictví Popis Výchozí
typesFilePath Cesta k souboru, který obsahuje oprávnění požadovaná pro volání rozhraní API CSOM služby SharePoint ~appFolder/config/spo-csom-types.json

Možnosti příkazového řádku

Žádné

Poznámky

Modul MinimalCsomPermissionsPlugin plug-in zjistí, jaká oprávnění klientská aplikace potřebuje minimálně k volání sady rozhraní API CSOM služby SharePoint. Modul plug-in k detekci těchto minimálních oprávnění používá informace o oprávněních pro rozhraní API CSOM služby SharePoint umístěné v zadaném souboru typů CSOM služby SharePoint.

Soubor typů CSOM SharePointu

Používá MinimalCsomPermissionsPlugin soubor typů CSOM k určení minimálních oprávnění, která klientská aplikace potřebuje k volání konkrétní sady rozhraní CSOM API. Soubor typů CSOM je soubor JSON, který obsahuje informace o typech CSOM SharePointu a jejich oprávněních. Následující příklad ukazuje příklad souboru typů CSOM:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.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": [
      ]
    }
  }
}

Soubor se skládá ze tří hlavních částí:

  • types
  • returnTypes
  • actions

Oddíl types obsahuje seznam typů CSOM SharePointu a jejich ID. Tato část je součástí čitelnosti, protože je srozumitelnější Microsoft.SharePoint.Client.RequestContext.Current než 3747adcd-a3c3-41b9-bfab-4a64dd2f1e0a.Current.

Oddíl returnTypes obsahuje seznam návratových typů pro metody v oddílu actions . Modul plug-in používá tyto informace při analýze požadavků CSOM k procházení hierarchie rozhraní API CSOM.

Tato actions část obsahuje seznam akcí, které je možné provést pomocí rozhraní API CSOM služby SharePoint. Pro každou akci uvádí delegovaná oprávnění a oprávnění aplikace, která může klientská aplikace použít k provedení této akce. Oprávnění jsou seřazena vzestupně podle jejich oprávnění, takže nejnižší privilegovaná oprávnění jsou uvedena jako první.

K dnešnímu dni není soubor typů CSOM, který jsme zahrnuli s dev proxy serverem, neúplný. Spolupracujeme s naší komunitou na dokumentování dalších typů. Mezitím ho můžete aktualizovat tak, aby zahrnoval typy a oprávnění, která potřebujete, pokud chybí informace, které potřebujete. Pak můžete použít vlastní typy souborů. Doporučujeme, abyste se svými změnami přispěli zpět do komunity, abychom z nich mohli těžit, a to vytvořením žádosti o přijetí změn v úložišti ukázek dev proxy serveru. Pravidelně načítáme nejnovější změny z úložiště dev proxy, abyste mohli využívat nejnovější změny bez nutnosti aktualizovat instalaci dev proxy serveru.