Edit

filter resource type

  • Article

Namespace: microsoft.graph

Determines which objects should be provisioned to the application. For example, you might want to only provision users that are located in the US. When a scoping filter is present, objects that don't satisfy the filter is skipped during synchronization.

Filter is part of object mapping. It consists of several sets of filter groups, and each filter group holds one or more clauses. An object is considered in scope for the group (the group is evaluated to true) only if all the clauses of the group are evaluated to true.

An object is considered in scope for the group set (group set is evaluated to true) if any of the groups in the set is evaluated to true.

For more information, see Attribute-based application provisioning with scoping filters

Properties

Property Type Description
categoryFilterGroups filterGroup collection *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 filterGroup collection 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 filterGroup collection *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.

JSON representation

The following JSON representation shows the resource type.

{
  "categoryFilterGroups": [
    {
      "@odata.type": "microsoft.graph.filterGroup"
    }
  ],
  "groups": [
    {
      "@odata.type": "microsoft.graph.filterGroup"
    }
  ],
  "inputFilterGroups": [
    {
      "@odata.type": "microsoft.graph.filterGroup"
    }
  ]
}