All integration guides

PaylocityEntra ID

Connect Paylocity to Entra ID

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

Paylocity fields mapped
13
Steps to go live
9
Employee records stored in our cloud
0

Joiners, movers and leavers

How Paylocity updates Entra ID

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

Joiner

An account before day one

A new hire is added to Paylocity with a hire date and Active status.

  • Account created in the tenant, disabled until the start date
  • Name, email, title, department, office and manager set from Paylocity
  • 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, cost center, work location or supervisor changes in Paylocity’s Position section.

  • 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 Paylocity, or the employee status changes to Terminated.

  • 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 Paylocity admin and a directory admin to complete the setup.

In Paylocity
  • Paylocity admin access and authorization to request Web Services API access
  • A work email or employee ID for each person in Paylocity 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 Paylocity with Entra ID

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

  1. 01

    Paylocity

    Request Web Services API access

    Web Services Access Request Form → Open API Access → Get Employee (Restricted)

    An authorized Paylocity contact must submit the Web Services Access Request Form. Select New Access and Production, then enter the credential recipient and renewal email address. Under Open API Access, select Get Employee (Restricted) only. Leave other endpoints and Webhook Push Notifications unselected.

    For ezOnboard’s partner application, enter ezOnboard under Vendor/Third-Party Contact Information. For your own credentials, name your team as the recipient. Email the form to webservices@paylocity.com with the subject API Access. Paylocity may charge for access.

    • Request Type: New Access, Production
    • Open API Access: Get Employee, Restricted
    • Webhook Push Notifications: none

    Access request form. Select Get Employee (Restricted) only and leave webhooks blank.

  2. 02

    Paylocity

    Save the Company ID and credentials

    Dashboard → Company ID

    Paylocity emails the client ID and secret to the recipient on the form. Store them securely. The secret expires after 12 months; Paylocity sends a renewal notice beforehand. You don’t need your own credentials when using ezOnboard’s partner application.

    Note the Company ID in the upper left of the Paylocity dashboard, such as B6001. Enter it exactly as shown; it is case-sensitive. You’ll need it and any client credentials in step 5.

    Company ID and credentials. The Company ID is in the upper left of the dashboard.

  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 Paylocity, 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 Paylocity as an HR source

    In the portal, add Paylocity as an HR source using the Company ID and client credentials. Your credentials are encrypted with your organization’s key and sent to your agent. The agent reads Paylocity 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 Paylocity every five minutes and catches up on any missed changes.

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

  6. 06

    ezOnboard portal

    Map Paylocity fields to Entra ID attributes

    Choose which Paylocity 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 Paylocity 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 Paylocity 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 Paylocity 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 Paylocity. 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

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

Paylocity fieldEntra ID attributeHow it’s used
First NameDemographicsgivenNameSets the first name at account creation and keeps it up to date.
Last NameDemographicssurnameKeeps the last name up to date. Also updates the logon name if your naming rule uses it.
Preferred NameDemographicsdisplayNameUses the preferred name for the display name and email. Uses the first name if blank.
Work EmailDemographicsmail, userPrincipalNameSets the email address and sign-in name. A mail rule can also generate them from the person’s name.
Employee IDDemographicsemployeeIdAdded to new accounts and used first to match existing accounts.
Job TitleEmployment › PositionjobTitleKeeps the job title up to date and sets groups based on your rules.
Cost Center 1Employment › PositiondepartmentKeeps the department up to date from your first cost center level. Rules can use it to choose account placement and groups.
Work LocationEmployment › PositionofficeLocationKeeps the office up to date. A lookup table can also fill in the street, city and country.
SupervisorEmployment › PositionmanagerLinks to the supervisor’s account to keep approvals and org charts in sync with Paylocity.
Employee TypeEmployment › PositionaccountEnabledRules can use Full Time, Part Time or Contractor to choose groups and licenses.
Hire DateEmployment › StatusaccountEnabledSets when the account is created and enabled. You choose how many days before the hire date to create it.
Employee StatusEmployment › StatusaccountEnabledActive keeps the account enabled. Terminated disables it when no other record keeps the person active.
Termination DateEmployment › StatusaccountEnabledSets the date for disabling the account and starting offboarding. Your rules set the time.

Frequently asked questions

Does ezOnboard write to Paylocity?
No. ezOnboard only reads Paylocity, so request Get Employee access only. It never uses the New Hire or Employee Update endpoints. Make any corrections in Paylocity.
Which Paylocity permissions does the integration need?
Request Get Employee (Restricted), which excludes pay rates and Social Security numbers. No other endpoints or webhooks are needed. Paylocity authorizes access for your Company ID.
Do we need Paylocity’s Entra ID integration or SCIM?
No. ezOnboard reads Paylocity’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 Paylocity, 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 Paylocity change reach Entra ID?
The agent checks Paylocity 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 Paylocity 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 Paylocity connected to Entra ID

Get a demo for your Paylocity 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.