Edit

Share via

bulkUpload resource type

  • Article

Namespace: microsoft.graph

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 capability of the Microsoft Entra synchronization service to process bulk uploads. For more information, see API-driven inbound provisioning concepts.

Methods

Method Return type Description
Perform bulk upload None Perform a new bulk upload using the synchronization job.

Properties

The bulkUpload resource type accepts the following properties in the payload:

  • The schemas parameter at the root level that must be set to urn:ietf:params:scim:api:messages:2.0:BulkRequest. Required. The following JSON block shows a representation of the schemas parameter.

    "schemas": [
  "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
]

  • The Operations parameter contains an array of key-value pairs. Each request can contain a maximum of 50 user operations under this parameter. The following key-value pairs are required in each object in the array.

    • method key must be set to POST

    Note

    When the method key is set to POST, the provisioning service will determine the right operation to perform on the target (create/update/enable/disable) based on the attribute mapping configuration. For example, if you have set {externalId,employeeId} as the matching identifier pair, then the provisioning service will check if a user with the employeeId exists in Microsoft Entra ID. If it doesn't exist, then the provisioning service will create the user. If it exists, then the provisioning service will update the user record.

    • path key always set to the value /Users
    • bulkId key set to a unique ID value. For example, if the data is coming from an HR source, you may set this value to employeeId which is guaranteed to be unique in the HR system.
    • data object. Required. The data object must have the following objects:
    • The schemas array under the data object must have the schemas: urn:ietf:params:scim:schemas:core:2.0:User and urn:ietf:params:scim:schemas:extension:enterprise:2.0:User representing the SCIM schema URI for the Core User Resource and the Enterprise User Extension, respectively. You may include additional custom SCIM schema names in case of attribute extensions.
    • externalId key set to a unique identifier in the source system. For example, employeeId or personId or studentId.

    The following JSON sample shows an example of an Operations object.

    {
    "method": "POST",
    "bulkId": "d63f4f30-a198-43db-a34d-f72bfa1f551e",
    "path": "/Users",
    "data": {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "externalId": "EMP1830"
  ... [You may include other SCIM attributes and extensions under the data object.]
    }
  }

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.bulkUpload"
}