Collection Contracts — Microsoft SharePoint (on-premises)
01How to Read This Page #sec_10d0227f
Each resource that REVIEWIT can collect for Microsoft SharePoint (on-premises) has a published contract. It is read as an API reference: what REVIEWIT calls on the collected service and by what means, what the contract requires for the collection to execute, and the data REVIEWIT retains. REVIEWIT only performs reads.
- Calls: the requests REVIEWIT sends to the collected service, all in read mode.
- Requirements: each must be satisfied. Its nature indicates what it demands: a right to grant to the identifier, an administration condition (a setting or assignment at the provider that the token does not carry, verified by a real read call), or the identifier's membership in the SharePoint farm of the connection. The rule states how many options are needed: “required” for the single option, “one of” when one is sufficient (they are ordered from narrowest to broadest: prefer the first), “all”, or “N of M”.
- Operational Conditions: what REVIEWIT verifies before each collection, beyond the requirements.
- Freshness: the maximum age of the verifications on which the verdict relies, set by each contract (here: verifications less than 24 hours old; rights must be verified by a real call). REVIEWIT does not yet verify this solution: this duration will apply to its verifications as soon as it performs them.
- Data Retained: the fields REVIEWIT keeps from each object; the role indicates what the review does with it.
The verdict for each resource, for your connection, is read on its card. A resource that the connection does not collect can still be fed by importing a report (“Import a report”).
02How REVIEWIT Verifies Requirements #sec_62891b78
For Microsoft SharePoint (on-premises), the service account rights cannot be read from any token: the contract requires that they be verified by a real read call. REVIEWIT does not yet make this call for Microsoft SharePoint (on-premises): neither the service account authentication nor its rights are verified. Resources appear as “Not verified”; they can still be fed by importing a report (“Import a report”).
03Call Paths #sec_bd6da6ea
A path indicates which token REVIEWIT obtains for the identifier: who issues it and for which audience. The addresses called are listed in the calls of each resource; a path starting with “/” is called on the token's audience of its path.
| Path | Token Issued By | Token Audience | Identifier Authentication |
|---|---|---|---|
| sp-onprem.server.reviewit.agent | no token: Windows (Active Directory) authentication of the service account | https://{farm} | service account password (Active Directory) |
An on-premises path does not issue any token: the service account authenticates via Windows (Active Directory) to the server, and it is this authentication that REVIEWIT verifies.
In these addresses, {farm} is the address of the SharePoint farm.
04SharePoint OnPremise · Sites #sec_35b75973
sp-onprem.sharepoint.sites:collect · contract revision 2, published on October 18, 2026 · path sp-onprem.server.reviewit.agent
Collections of sites in the SharePoint farm and their role assignments
{site} refers to the address of a site collection, as enumeration renders it (Path).
Calls
- GET https://{farm}/_api/search/query?querytext='contentclass:STS_Site'&selectproperties='Title,Path,SiteId'&rowlimit=500 (enumeration of site collections in the farm)
- GET {site}/_api/site
- GET {site}/_api/web?$select=Id,Title,Url,Created,LastItemModifiedDate
- GET {site}/_api/web/roleassignments?$expand=Member,RoleDefinitionBindings
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | web application policy “Full Read” granted to the service account in Central Administration |
| Membership | required | the identifier belongs to the SharePoint farm of the connection |
Operational Conditions
- the service account authenticates (Windows authentication, Active Directory)
- the service https://{farm} responds
Freshness: verifications less than 24 hours old; rights must be verified by a real call.
Data Retained
| Field | Role | Type | Required |
|---|---|---|---|
| Id | object key | integer | yes |
| Title | displayed to recognize the object | text | yes |
| Url | displayed to recognize the object | text | no |
| Owners | access subject to review | list of identities | no |
| Members | access subject to review | list of identities | no |
| Admin | access subject to review | list of identities | no |
| Guests | access subject to review | list of identities | no |
| Type | context, no effect on review | text | no |
| Created | context, no effect on review | date and time | no |
| LastModified | context, no effect on review | date and time | no |
| LastActivityDate | evaluated by REVIEWIT policies (date of last activity) | date and time | no |
| Size | context, no effect on review | integer | no |
05SharePoint OnPremise · Subsites #sec_8322202c
sp-onprem.sharepoint.subsites:collect · contract revision 2, published on October 18, 2026 · path sp-onprem.server.reviewit.agent
Subsites of the SharePoint farm and the inheritance of their permissions
{site} refers to the address of a site collection (Sites resource enumeration); {web} refers to a subsite, such as /_api/web/webs renders it (Url).
Calls
- GET {site}/_api/web/webs?$select=Id,Title,Url,HasUniqueRoleAssignments (recursive, for each site collection, excluding the root site)
- GET {web}/_api/web/roleassignments?$expand=Member,RoleDefinitionBindings
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | web application policy "Full Read" granted to the service account in Central Administration |
| Membership | required | the identifier belongs to the SharePoint farm of the connection |
Operating Conditions
- the service account authenticates (Windows authentication, Active Directory)
- the service https://{farm} responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data Retained
| Field | Role | Type | Required |
|---|---|---|---|
| Id | object key | integer | yes |
| Title | displayed to recognize the object | text | yes |
| Url | displayed to recognize the object | text | no |
| Owners | access subject to review | list of identities | no |
| Members | access subject to review | list of identities | no |
| Visitors | access subject to review | list of identities | no |
| Guests | access subject to review | list of identities | no |
| Type | context, no effect on review | text | no |
| Created | context, no effect on review | date and time | no |
| LastModified | evaluated by REVIEWIT policies (date of last activity) | date and time | no |
| ParentId | context, no effect on review | text | no |
| InheritsPermissions | context, no effect on review | boolean | no |
| Size | context, no effect on review | integer | no |
06To Go Further #sec_330f1291
- Understand a collection connection
- Rights reference by resource
- Read a verdict