Microsoft Graph · Schema

filter

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks

Properties

Name Type Description
categoryFilterGroups array *Experimental* Filter group set used to decide whether given object belongs and should be processed as part of this object mapping. An object is considered in scope if ANY of the groups in the collect
groups array Filter group set used to decide whether given object is in scope for provisioning. This is the filter which should be used in most cases. If an object used to satisfy this filter at a given moment, an
inputFilterGroups array *Experimental* Filter group set used to filter out objects at the early stage of reading them from the directory. If an object doesn't satisfy this filter, then it will not be processed further. Impor
@odata.type string
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphfilter-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.filter",
  "title": "filter",
  "required": [
    "@odata.type"
  ],
  "type": "object",
  "properties": {
    "categoryFilterGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.filterGroup"
      },
      "description": "*Experimental* Filter group set used to decide whether given object belongs and should be processed as part of this object mapping. An object is considered in scope if ANY of the groups in the collection is evaluated to true."
    },
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.filterGroup"
      },
      "description": "Filter group set used to decide whether given object is in scope for provisioning. This is the filter which should be used in most cases. If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get deprovisioned'. An object is considered in scope if ANY of the groups in the collection is evaluated to true."
    },
    "inputFilterGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.filterGroup"
      },
      "description": "*Experimental* Filter group set used to filter out objects at the early stage of reading them from the directory. If an object doesn't satisfy this filter, then it will not be processed further. Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get deprovisioned. An object is considered in scope if ANY of the groups in the collection is evaluated to true."
    },
    "@odata.type": {
      "type": "string"
    }
  }
}