All integration guides

InsperityEntra ID

Connect Insperity to Entra ID

Turn Insperity hires, changes and departures into account updates in Entra ID. Follow the setup steps, preview changes with a dry run, then go live.

Insperity fields mapped
12
Steps to go live
9
Employee records stored in our cloud
0

Joiners, movers and leavers

How Insperity updates Entra ID

HR updates Insperity. ezOnboard updates accounts based on your rules.

Joiner

An account before day one

A new hire is entered in Insperity Premier with a hire date.

  • Account created in the tenant, disabled until the start date
  • Name, email, title, department, office and manager set from Insperity
  • Account added to its administrative unit and groups, with group-based licenses assigned
  • Account enabled on the start date, with a Temporary Access Pass for first sign-in

Mover

Access for the new role

A job title, department, work location or supervisor changes in Insperity Premier.

  • Title, department, office and manager updated
  • Account moved to the administrative unit your rules specify
  • Groups and group-based licenses updated to match the new role

Leaver

Offboarding on schedule

A termination date is set in Insperity Premier.

  • Account disabled on the termination date, never deleted
  • Sign-in sessions revoked
  • Direct licenses recovered and account removed from managed groups

Before you start

What to have ready

Work with a Insperity admin and a directory admin to complete the setup.

In Insperity
  • Insperity Premier administrator access, and an officer who can sign Insperity’s API Terms of Use
  • A work email or employee ID for each person in Insperity Premier to match them to their account
In Entra ID
  • A server running Windows Server 2019 or later; no domain join required
  • A Global Administrator to grant consent to the ezOnboard application
  • Outbound HTTPS to the HR system, ezOnboard, graph.microsoft.com and login.microsoftonline.com
  • Administrative units and groups for ezOnboard to manage, and Temporary Access Pass enabled in your authentication methods policy

Step by step

Set up Insperity with Entra ID

Start in Insperity and on your server. Then finish in the ezOnboard portal with our implementation team.

  1. 01

    Insperity

    Request API access from Insperity

    Insperity service team → integrationspecialists@insperity.com

    Request API access from Insperity’s integration specialists. Each key is limited to the endpoints and IP addresses in your request.

    Have an authorized officer sign Insperity’s API Terms of Use. Email the signed form to integrationspecialists@insperity.com. Request an API key for ezOnboard and include the endpoints below and your agent network’s public IP address. Request read access only.

    • employeescompany: first name, last name and employee ID
    • employeesposition: job title, department, work location and supervisor
    • employeescommunication: work email
    • employeesemployment: hire date, employment status and termination date
    • departments: department names

    API access request. Attach the signed Terms of Use and list the endpoints and your IP address.

  2. 02

    Insperity

    Save the Company ID and API key

    Insperity Premier → Employee Directory

    Find your Company ID beside the company name in Insperity Premier’s Employee Directory. Note each company ID ezOnboard should read.

    Insperity sends the API key after approving your request and IP address. Store it securely. It can access only the endpoints you requested. You’ll need the Company ID and key in step 5.

    Employee Directory. The Company ID is beside the company name.

  3. 03

    Your server

    Install the ezOnboard agent

    The agent runs as a Windows service on your server with Windows Server 2019 or later. No domain join is required. It connects to Insperity, ezOnboard and Microsoft Graph over outbound HTTPS. No inbound firewall rules are needed.

    Download the signed MSI and enrollment bundle from the portal. Save the install code. The portal shows it only once. Run the MSI and enter the code. The agent uses a local virtual account by default, with no password to manage. The installer checks outbound access and the clock before making changes. Domain and LDAP checks show “not needed”.

    Installer screen with the setup requirements.

  4. 04

    ezOnboard portal and Microsoft

    Connect your tenant and grant admin consent

    Add a Microsoft 365 connection in the portal. Choose the Directory and Licenses capabilities, then continue to Microsoft. Sign in as a Global Administrator and grant consent. The portal shows which capabilities have access. You can grant missing permissions later.

    ezOnboard uses application permissions, not an administrator account or password. Revoke consent in Entra ID to remove its access. Each tenant connects to one organization.

    • Directory: manage users, managers, group memberships and administrative units
    • Licenses: read subscriptions, assign licenses and recover unused licenses
    • Sign-in: revoke sessions for leavers and issue a Temporary Access Pass to new hires

    Connection page showing which capabilities have access.

  5. 05

    ezOnboard portal

    Add Insperity as an HR source

    In the portal, add Insperity as an HR source using the Company ID and API key. Your credentials are encrypted with your organization’s key and sent to your agent. The agent reads Insperity from your network. Nobody at ezOnboard can read the credentials.

    Choose a field to match people across both systems, usually work email or employee ID. The agent checks Insperity every five minutes and catches up on any missed changes.

    HR source. Your agent uses these credentials to read Insperity.

  6. 06

    ezOnboard portal

    Map Insperity fields to Entra ID attributes

    Choose which Insperity fields update each directory attribute. Start with the defaults below, add custom fields or combine values. For example, build a display name from first and last names, format a job title or look up an office address by site.

    Blank Insperity fields leave directory values unchanged unless you configure the mapping to clear them.

    Field mapping. See the full list of defaults below.

  7. 07

    ezOnboard portal

    Set rules for accounts, administrative units and groups

    Rules define who gets an account, which administrative unit it belongs to, how it’s named and which groups it joins. They also control offboarding. Use Insperity fields, such as department and site, to make those choices.

    Our implementation team helps you write the rules. With approvals enabled, your team must approve each rule change before the agent uses it.

    Rules page with the placement rule open.

  8. 08

    ezOnboard portal

    Preview changes with a dry run

    Run a dry run for your whole workforce. The agent matches Insperity records to existing accounts by employee ID, then work email, and previews changes without applying them. If two accounts match one person, that action stops for review.

    Review the planned changes and the rules behind them in the portal. Adjust your rules and repeat the dry run until the results match your expectations.

    Dry run. No changes are applied while dry run is on.

  9. 09

    ezOnboard portal

    Go live

    Turn off dry run to apply changes. If a run would disable or move more accounts than your safety limits allow, it stops and alerts your team before making changes. We review the first runs with you.

    HR continues working in Insperity. Your rules handle new accounts, updates and offboarding on schedule. Get alerts by email, in the portal or by webhook when a run stops, the HR feed stops updating or the agent stops reporting. An inactive feed never triggers offboarding.

    Reports with account activity, tickets avoided and agent uptime.

Field mapping

Insperity fields and Entra ID attributes

Start with these defaults and adjust any mapping. Dates and lifecycle status control when accounts are created, enabled or disabled.

Insperity fieldEntra ID attributeHow it’s used
First nameEmployeegivenNameSets the first name at account creation and keeps it up to date.
Last nameEmployeesurnameKeeps the last name up to date. Also updates the logon name if your naming rule uses it.
Preferred nameEmployeedisplayNameUses the preferred name for the display name and email. Uses the first name if blank.
Work emailCommunicationmail, userPrincipalNameSets the email address and sign-in name. A mail rule can also generate them from the person’s name.
Employee IDEmployeeemployeeIdAdded to new accounts and used first to match existing accounts.
Job titlePositionjobTitleKeeps the job title up to date and sets groups based on your rules.
DepartmentPositiondepartmentKeeps the department up to date. Rules can use it to choose account placement and groups.
Work locationPositionofficeLocationKeeps the office up to date. A lookup table can also fill in the street, city and country.
SupervisorPositionmanagerLinks to the supervisor’s account to keep approvals and org charts in sync with Insperity.
Hire dateEmploymentaccountEnabledSets when the account is created and enabled. You choose how many days before the hire date to create it.
Employment statusEmploymentaccountEnabledActive keeps the account enabled. Terminated disables it when no other record keeps the person active.
Termination dateEmploymentaccountEnabledSets the date for disabling the account and starting offboarding. Your rules set the time.

Frequently asked questions

Does ezOnboard write to Insperity Premier?
No. ezOnboard only reads Insperity’s API, so request the read-only employee endpoints and nothing else. Make any corrections in Insperity Premier or through your Insperity service team.
Which Insperity endpoints does the API key need?
Request employeescompany, employeesposition, employeescommunication, employeesemployment and departments. No compensation or payroll access is needed. The key works only with the endpoints and IP addresses in your request.
Do we need Insperity’s Entra ID integration or SCIM?
No. ezOnboard reads Insperity’s API and uses your rules to manage accounts in Active Directory or Entra ID. Its agent runs on your network and can also manage Exchange.
Do we need a server for Entra ID?
Yes. Use a Windows Server with outbound HTTPS to Insperity, ezOnboard and Microsoft Graph. No domain join or inbound firewall rules are required. The agent runs as a local virtual account by default and keeps employee data on your network. It doesn’t store tenant administrator credentials.
What permissions does ezOnboard need in Entra ID?
A Global Administrator grants consent to the ezOnboard application. Permissions are grouped by capability, such as managing users or assigning licenses. You can grant additional capabilities later. Revoke consent in Entra ID to remove access.
How quickly does a Insperity change reach Entra ID?
The agent checks Insperity every five minutes and usually applies changes within seconds of finding them. Scheduled changes follow your rules: accounts are created before the start date, enabled on that date and disabled on the termination date at the time you choose.
How does Insperity trigger offboarding in Entra ID?
On the termination date, the account is disabled and its sign-in sessions are revoked. Direct licenses are recovered. The account is removed from managed groups, releasing their licenses. The account is never deleted. Every step is recorded for audit.
How do new hires sign in?
With a Temporary Access Pass issued when their account is enabled on the start date. ezOnboard emails it to their manager or an address set by your rules. Enable Temporary Access Pass in your authentication methods policy and provide an Exchange Online mailbox to send from.
Which guide should we use for a hybrid directory?
Use the Active Directory guide if your accounts sync to Entra ID through Entra Connect. The agent updates on-premises accounts and manages licenses and mailboxes in the cloud. It won’t change cloud attributes owned by Entra Connect. This guide covers cloud-only accounts.

Get a demo

See Insperity connected to Entra ID

Get a demo for your Insperity and Entra ID setup. For questions, email sales@ezonboard.io.

Optional

This site is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.