Edit

Share via

userProvisioningFlow resource type

  • Article

Namespace: microsoft.graph.industryData

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents the configuration parameters that allow you to automate creation and matching to Microsoft 365 users from your inbound data.

userProvisioningFlow is defined within an outboundProvisioningFlowSet that may specify a filter based on a subset of available organizations (schools) or may include all of the organizations in the inbound data.

There may be multiple userProvisioningFlows, defined within separate outboundProvsioningFlowSets allowing different configurations for different organizations.

Inherits from microsoft.graph.industryData.provisioningFlow.

Methods

Method Return type Description
Get microsoft.graph.industryData.userProvisioningFlow Read the properties and relationships of a userprovisioningflow object.
Update microsoft.graph.industryData.userProvisioningFlow Update the properties of a userprovisioningflow object.
Delete None Delete a userprovisioningflow object.

Properties

Property Type Description
createdDateTime DateTimeOffset Inherited from microsoft.graph.industryData.provisioningFlow.
createUnmatchedUsers Boolean A Boolean choice indicating whether unmatched users should be created or ignored.
creationOptions microsoft.graph.industryData.userCreationOptions The different management choices for the new users to be provisioned.
id String Inherited from microsoft.graph.industryData.provisioningFlow.
lastModifiedDateTime DateTimeOffset Inherited from microsoft.graph.industryData.provisioningFlow.
managementOptions microsoft.graph.industryData.userManagementOptions The different attribute choices for all the users to be considered.
readinessStatus microsoft.graph.industryData.readinessStatus Inherited from microsoft.graph.industryData.provisioningFlow. The possible values are: notReady, ready, failed, disabled, expired, unknownFutureValue.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.industryData.userProvisioningFlow",
  "createdDateTime": "String (timestamp)",
  "lastModifiedDateTime": "String (timestamp)",
  "readinessStatus": "String",
  "id": "String (identifier)",
  "createUnmatchedUsers": "Boolean",
  "managementOptions": {
    "@odata.type": "microsoft.graph.industryData.userManagementOptions"
  },
  "creationOptions": {
    "@odata.type": "microsoft.graph.industryData.userCreationOptions"
  }
}