Edit

Share via

Create provisioningFlow

  • 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.

Create a new provisioningFlow object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ❌ ❌ ❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permission Higher privileged permissions
Delegated (work or school account) IndustryData-OutboundFlow.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application IndustryData-OutboundFlow.ReadWrite.All Not available.

HTTP request

POST /external/industryData/outboundProvisioningFlowSets/{id}/provisioningFlows

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the provisioningFlow object.

Any of the following provisioning flows are valid:

Response

If successful, this method returns a 201 Created response code and a provisioningFlow object in the response body.

Examples

Example 1: Create an administrativeUnitProvisioningFlow

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.industryData.administrativeUnitProvisioningFlow",
  "creationOptions":
  {
    "createBasedOnOrg": true,
    "createBasedOnOrgPlusroleGroup": true
  }
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity",
    "@odata.type": "#microsoft.graph.industryData.administrativeUnitProvisioningFlow",
    "id": "f66e97ad-0870-46e0-3ff3-08dc49dccdc9",
    "createdDateTime": "2024-03-22T21:28:02.7164229Z",
    "lastModifiedDateTime": "2024-03-22T21:28:02.7164229Z",
    "readinessStatus": "notReady",
    "creationOptions": {
        "createBasedOnOrg": true,
        "createBasedOnOrgPlusRoleGroup": true
    }
}

Example 2: Create a classGroupProvisioningFlow

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows
Content-type: application/json

{
    "@odata.type": "#microsoft.graph.industryData.classGroupProvisioningFlow",
    "configuration": {
        "@odata.type": "#microsoft.graph.industryData.classGroupConfiguration",
        "additionalAttributes": [
            "courseTitle",
            "courseCode",
            "courseSubject",
            "courseGradeLevel",
            "courseExternalId",
            "academicSessionTitle",
            "academicSessionExternalId"
        ],
        "additionalOptions": {
            "@odata.type": "#microsoft.graph.industryData.additionalClassGroupOptions",
            "createTeam": true,
            "writeDisplayNameOnCreateOnly": true
        },
        "enrollmentMappings": {
            "@odata.type": "#microsoft.graph.industryData.enrollmentMappings",
            "ownerEnrollmentMappings": [
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "teacher"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "proctor"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "teacherAssistant"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "paraProfessional"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "physicalTherapist"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "speechTherapist"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "visionTherapist"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "occupationalTherapist"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "staff"
                }
            ],
            "memberEnrollmentMappings": [
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "student"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "substitute"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "aide"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "proctor"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "teacherAssistant"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "paraProfessional"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "physicalTherapist"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "speechTherapist"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "visionTherapist"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "occupationalTherapist"
                },
                {
                    "@odata.type": "#microsoft.graph.industryData.sectionRoleReferenceValue",
                    "code": "staff"
                }
            ]
        }
    }
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity",
    "@odata.type": "#microsoft.graph.industryData.classGroupProvisioningFlow",
    "id": "417a82c8-7caa-4f82-3ac6-08dc4ac6fb7f",
    "createdDateTime": "2024-03-22T23:34:18.5035988Z",
    "lastModifiedDateTime": "2024-03-22T23:34:18.5035988Z",
    "readinessStatus": "notReady",
    "configuration": {
        "additionalAttributes": [
            "courseTitle",
            "courseCode",
            "courseSubject",
            "courseGradeLevel",
            "courseExternalId",
            "academicSessionTitle",
            "academicSessionExternalId"
        ],
        "additionalOptions": {
            "createTeam": true,
            "writeDisplayNameOnCreateOnly": true
        },
        "enrollmentMappings": {
            "ownerEnrollmentMappings": [
                {
                    "code": "teacher"
                },
                {
                    "code": "proctor"
                },
                {
                    "code": "teacherAssistant"
                },
                {
                    "code": "paraprofessional"
                },
                {
                    "code": "physicalTherapist"
                },
                {
                    "code": "speechTherapist"
                },
                {
                    "code": "visionTherapist"
                },
                {
                    "code": "occupationalTherapist"
                },
                {
                    "code": "staff"
                }
            ],
            "memberEnrollmentMappings": [
                {
                    "code": "student"
                },
                {
                    "code": "substitute"
                },
                {
                    "code": "aide"
                },
                {
                    "code": "proctor"
                },
                {
                    "code": "teacherAssistant"
                },
                {
                    "code": "paraprofessional"
                },
                {
                    "code": "physicalTherapist"
                },
                {
                    "code": "speechTherapist"
                },
                {
                    "code": "visionTherapist"
                },
                {
                    "code": "occupationalTherapist"
                },
                {
                    "code": "staff"
                }
            ]
        }
    }
}

Example 3: Create a securityGroupProvisioningFlow

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.industryData.securityGroupProvisioningFlow",
  "creationOptions":
  {
    "createBasedOnroleGroup": true,
    "createBasedOnOrgPlusroleGroup": false
  }
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity",
    "@odata.type": "#microsoft.graph.industryData.securityGroupProvisioningFlow",
    "id": "4598f62a-7bd9-40a1-d38a-08dc4ac68cf2",
    "createdDateTime": "2024-03-22T23:55:06.3141592Z",
    "lastModifiedDateTime": "2024-03-22T23:55:06.3141592Z",
    "readinessStatus": "notReady",
    "creationOptions": {
        "createBasedOnRoleGroup": true,
        "createBasedOnOrgPlusRoleGroup": false
    }
}

Example 4: Create a userProvisioningFlow

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/external/industryData/OutboundProvisioningFlowSets/9ab41255-5364-4c53-e15c-08dc4ab6ee03/provisioningFlows
Content-type: application/json

{
    "@odata.type": "#microsoft.graph.industryData.userProvisioningFlow",
    "createUnmatchedUsers": true,
    "managementOptions":
    {
        "additionalAttributes": ["userGradeLevel"],
        "additionalOptions":
        {
            "markAllStudentsAsMinors": true,
            "allowStudentContactAssociation"  : false
        }
    },
    "creationOptions":
    {
        "configurations": [
          {
            "roleGroup@odata.bind": "https://graph.microsoft.com/beta/external/industryData/roleGroups/staff",
            "defaultPasswordSettings":
            {
              "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings",
              "password": "********"
            },
            "licenseSkus": [ "Sku1"]
          },
          {
            "roleGroup@odata.bind": "https://graph.microsoft.com/beta/external/industryData/roleGroups/students",
            "defaultPasswordSettings":
            {
              "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings",
              "password": "********"
            },
            "licenseSkus": [ "Sku2"]
          }
        ]
    }
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('9ab41255-5364-4c53-e15c-08dc4ab6ee03')/provisioningFlows/$entity",
    "@odata.type": "#microsoft.graph.industryData.userProvisioningFlow",
    "id": "dbd36d16-c574-4ed8-3ac7-08dc4ac6fb7f",
    "createdDateTime": "2024-03-23T00:24:32.3286035Z",
    "lastModifiedDateTime": "2024-03-23T00:24:32.3286035Z",
    "readinessStatus": "notReady",
    "createUnmatchedUsers": true,
    "managementOptions": {
        "additionalAttributes": [
            "userGradeLevel"
        ],
        "additionalOptions": {
            "markAllStudentsAsMinors": true,
            "allowStudentContactAssociation": false
        }
    },
    "creationOptions": {
        "configurations": [
            {
                "licenseSkus": [
                    "Sku1"
                ],
                "defaultPasswordSettings": {
                    "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings",
                    "password": "***************"
                }
            },
            {
                "licenseSkus": [
                    "Sku2"
                ],
                "defaultPasswordSettings": {
                    "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings",
                    "password": "***************"
                }
            }
        ]
    }
}