Documentation
Import users and groups from Apple Business
Connect an Apple Business API account, preview your Managed Apple Accounts and user groups, and match them to the people in your workspace.
Last checked · 2 min read
What it does
Vamiq reads the Managed Apple Accounts and user groups in Apple Business (formerly Apple Business Manager) through an Apple Business API account, and matches them to the people in your workspace and your app users. In Vamiq this is called Directory sync.
It does not import passwords or manage devices, and every plan, Free included, can use it.
This is different from Apple’s own directory sync, which brings people from Microsoft Entra ID or Google Workspace into Apple Business. Vamiq reads from Apple Business.
Connect the API account
Create an API account in Apple Business
Sign in to Apple Business as an administrator, open Settings → API and create an API account for Vamiq with access to users and user groups. Vamiq does not need device access.
Copy the IDs
Open the new account with Edit. Apple Business shows the full Client ID and Key ID there; the list page shows only a summary.
Download the private key
Download the private key. Apple may provide a single .pem file in EC PRIVATE KEY format; Vamiq accepts it as it is.
Connect it in Vamiq
In Vamiq, open Users → App users, find Directory sync and choose Connect Apple Business API account. Paste the Client ID and Key ID, upload the key file or paste its text, and choose Save API account. Vamiq checks the connection with Apple, then stores the key encrypted.
Preview the changes
Choose Run directory preview. Vamiq fetches your Apple Business users and groups and shows likely matches with your workspace members and app users. Nothing changes until you apply it.
Apply them
Choose Apply directory changes. Matching people get their Managed Apple Account from Apple Business; if you allow it, Vamiq also creates app users for people it could not match.
Resolve conflicts
If one Apple Business user could match more than one person, choose what happens: prefer the workspace member, prefer the app user, create an app user, or ignore. On Enterprise, we set up scheduled sync and group rules with you, so only approved Apple Business groups can create new app-user access.
Questions
- Is this the same as Apple Business directory sync?
- No. Apple’s directory sync brings people from Microsoft Entra ID or Google Workspace into Apple Business. Vamiq reads users and groups from Apple Business into your workspace.
- Does it import passwords?
- No. It reads names, Managed Apple Accounts and groups. It never imports passwords and does not manage devices.
- Which plans include it?
- Every plan, Free included. Scheduled sync and group rules are on Enterprise.
Primary sources
Use these first-party references to confirm programme eligibility, distribution rules, and platform behaviour.
- Apple Business User Guide: create an Apple Business API account — Where the API account is created, its private key downloaded and its details shown with Edit. Checked 21 October 2026.
- Apple Business User Guide: directory syncing with Apple Business — Apple’s own directory sync, from an identity provider into Apple Business. Checked 21 October 2026.