Редактиране

Споделяне чрез

API-driven inbound provisioning concepts

  • Статия

This document provides a conceptual overview of the Microsoft Entra API-driven inbound user provisioning.

Introduction

Today enterprises have various authoritative systems of record. To establish end-to-end identity lifecycle, strengthen security posture and stay compliant with regulations, identity data in Microsoft Entra ID must be kept in sync with workforce data managed in these systems of record. The system of record could be an HR app, a payroll app, a spreadsheet, or SQL tables in a database hosted either on-premises or in the cloud.

With API-driven inbound provisioning, the Microsoft Entra provisioning service now supports integration with any system of record. Customers and partners can use any automation tool of their choice to retrieve workforce data from the system of record and ingest it into Microsoft Entra ID. The IT admin has full control on how the data is processed and transformed with attribute mappings. Once the workforce data is available in Microsoft Entra ID, the IT admin can configure appropriate joiner-mover-leaver business processes using Lifecycle Workflows.

Supported scenarios

Several inbound user provisioning scenarios are enabled using API-driven inbound provisioning. This diagram demonstrates the most common scenarios.

Diagram showing API workflow scenarios.

Scenario 1: Enable IT teams to import HR data extracts using any automation tool

Flat files, CSV files and SQL staging tables are commonly used in enterprise integration scenarios. Employee, contractor, and vendor information are periodically exported into one of these formats and an automation tool is used to sync this data with enterprise identity directories. With API-driven inbound provisioning, IT teams can use any automation tool of their choice (example: PowerShell scripts or Azure Logic Apps) to modernize and simplify this integration.

Scenario 2: Enable ISVs to build direct integration with Microsoft Entra ID

With API-driven inbound provisioning, HR ISVs can ship native synchronization experiences so that changes in the HR system automatically flow into Microsoft Entra ID and connected on-premises Active Directory domains. For example, an HR app or student information systems app can send data to Microsoft Entra ID as soon as a transaction is complete or as end-of-day bulk update.

Scenario 3: Enable system integrators to build more connectors to systems of record

Partners can build custom HR connectors to meet different integration requirements around data flow from systems of record to Microsoft Entra ID.

In all of the above scenarios, integration is simplified as the Microsoft Entra provisioning service takes over the responsibility of performing identity profile comparison, restricting the data sync to scoping logic configured by the IT admin, and executing rule-based attribute flow and transformation managed in the Microsoft Entra admin center.

End-to-end flow

Diagram of the end-to-end workflow of inbound provisioning.

Steps of the workflow

  1. IT Admin configures an API-driven inbound user provisioning app from the Microsoft Entra Enterprise App gallery.
  2. IT Admin grants access permissions and provides endpoint access details to the API developer/partner/system integrator.
  3. The API developer/partner/system integrator builds an API client to send authoritative identity data to Microsoft Entra ID.
  4. The API client reads identity data from the authoritative source.
  5. The API client sends a POST request to provisioning /bulkUpload API endpoint associated with the provisioning app.

    Note

    The API client doesn't need to perform any comparisons between the source attributes and the target attribute values to determine what operation (create/update/enable/disable) to invoke. This is automatically handled by the provisioning service. The API client simply uploads the identity data read from the source system by packaging it as bulk request using SCIM schema constructs.

  6. If successful, an Accepted 202 Status is returned.
  7. The Microsoft Entra provisioning service processes the data received, applies the attribute mapping rules, and completes user provisioning.
  8. Depending on the provisioning app that's configured, the user is provisioned either into on-premises Active Directory (for hybrid users) or Microsoft Entra ID (for cloud-only users).
  9. The API Client then queries the provisioning logs API endpoint for the status of each record sent.
  10. If the processing of any record fails, the API client can check the error details and include records corresponding to the failed operations in the next bulk request (step 5).
  11. At any time, the IT Admin can check the status of the provisioning job and view events in the provisioning logs.

Key features of API-driven inbound user provisioning

  • Available as a provisioning app that exposes an asynchronous Microsoft Graph provisioning /bulkUpload API endpoint accessed using valid OAuth token.
  • Tenant admins must grant API clients interacting with this provisioning app the Graph permission SynchronizationData-User.Upload.
  • The Graph API endpoint accepts valid bulk request payloads using SCIM schema constructs.
  • With SCIM schema extensions, you can send any attribute in the bulk request payload.
  • The rate limit for the inbound provisioning API is 40 bulk upload requests per second. Each bulk request can contain a maximum of 50 user records, thereby supporting an upload rate of 2000 records per second.
  • Each API endpoint is associated with a specific provisioning app in Microsoft Entra ID. You can integrate multiple data sources by creating a provisioning app for each data source.
  • Incoming bulk request payloads are processed in near real-time.
  • Admins can check provisioning progress by viewing the provisioning logs.
  • API clients can track progress by querying provisioning logs API.

License requirements

This feature is available with Microsoft Entra ID P1, P2, and Microsoft Entra ID Governance licenses. To find the right license for your requirements, see Microsoft Entra ID Governance licensing fundamentals.

API usage guidance

The /bulkUpload API endpoint expands the number of ways that you can manage users in Microsoft Entra ID. To help you determine if the /bulkUpload API endpoint is right for your integration scenario, refer to this table that compares it with other API-based integration options.

Use Case Scenario to API mapping User creation API HR inbound bulk API User invitation API Direct assignment API
When your identity creation scenario is... Ad-hoc user creation in Microsoft Entra ID for a user not associated with any worker in an HR source Sourcing employee records from an authoritative HR source, and you want those employees to have "member" accounts in Microsoft Entra ID or on-premises Active Directory Ad-hoc guest user creation in Microsoft Entra ID, for sharing purposes, where the guest has unique access rights Access assignment for existing users, and (preview) guest creation in Microsoft Entra ID, to give the new guest standardized access
...use the API... Create user Perform bulkUpload. Create invitation Create accessPackageAssignmentRequest
The resulting user is first created in... Microsoft Entra ID On-premises Active Directory or Microsoft Entra ID Microsoft Entra ID Microsoft Entra ID
The resulting user authenticates to... Microsoft Entra ID, with the password you supply On-premises Active Directory of Microsoft Entra ID, with a Temporary Access Pass provided by Entra Lifecycle workflows Home tenant or other identity provider Home tenant or other identity provider
Subsequent updates to the user can be done via Graph API or Microsoft Entra admin center Graph API or HR inbound bulk API or Microsoft Entra admin center Graph API or Microsoft Entra admin center Graph API or Microsoft Entra admin center
The lifecycle of user when their employment starts, is determined by... Manual processes Entra onboarding Lifecycle workflows that trigger based on the employeeHireDate attribute Entitlement management Automatic assignment using Entitlement management access packages
The lifecycle of user when their employment is terminated is determined by... Manual processes Entra offboarding lifecycle workflows that trigger based on the employeeLeaveDateTime attribute Access reviews Entitlement management when the user loses their last access package assignment, they're removed
# Learning objective Guidance
1. You want to learn more about the inbound provisioning API specs. Refer to /bulkUpload API spec document.
2. You want to get more familiar with the API-driven provisioning concepts, scenarios and limitations. Refer to Frequently asked questions about API-driven inbound provisioning.
3. As an Admin user, you want to quickly test the inbound provisioning API. * Create API-driven inbound provisioning app
* Test API using Graph Explorer
4. With a service account or managed identity, you want to quickly test the inbound provisioning API. * Create API-driven inbound provisioning app
* Grant API permissions
* Test API using cURL
5. You want to extend the API-driven provisioning app to process more custom attributes. Refer to the tutorial Extend API-driven provisioning to sync custom attributes
6. You want to automate data upload from your system of record to the inbound provisioning API endpoint. Refer to the tutorials
* Quick start with PowerShell
* Quick start with Azure Logic Apps
7. You want to troubleshoot inbound provisioning API issues Refer to the Troubleshooting guide.

External learning resources

The following content, created by our partners and Microsoft MVPs, offers extra guidance on how to deploy and configure API-driven provisioning for various integration scenarios.

Next steps