Skip to content
Sign in Get started
Documentation

9bx user guide

Administration

Directory sync

Keep your people in step with Google Workspace, Microsoft 365, a directory server or your identity provider. New people get a login and an employee record, and people who leave are switched off.

Contents

Who can use it

Organization owners and administrators.

Where to find it

Settings → Security → Directory sync

Add a directory source

  1. Click Add directory source and choose the type: Google Workspace, Microsoft 365 (Entra ID), a directory server such as Active Directory, or SCIM (your identity provider pushes people to 9bx).
  2. Name it (for example "Acme Google Workspace") and fill the Connection details the form asks for. Keys are stored encrypted and never shown again.
  3. Under Sync choose what happens When someone leaves the directory (Switch their login off or Do nothing), whether to Add people to the phone book, whether to Keep roles in step with groups, and the Role and Branch for new people. Admin roles can never be chosen or given by sync.
  4. Save.

For SCIM there are no settings: after adding it, copy the SCIM base URL and Bearer token into your identity provider. Rotate token makes a new one and the old one stops at once.

Nobody is ever deleted. The owner and the last administrator are never switched off.

Mappings

Click Mappings on a source to match directory values to 9bx records.

Tab Matches
Departments A department in the directory to a 9bx department.
Offices to branches An office to a branch.
Groups to roles A group to an ordinary role.

A value with no row is matched to a 9bx record with the same name.

Preview and sync

  1. Test connection checks the login works.
  2. Preview shows who would be created, updated or switched off.
  3. Sync now applies it. Set Schedule to Manual only, Every hour or Every day for automatic runs.
  4. Log shows each run. A status of Synced with problems lists what to fix.

If a run holds back a large switch-off, nothing happens until you turn on Confirm switching off many people. Do this only if the directory really removed those people.

Removing a source stops syncing. The logins and employees it made stay as they are.

Troubleshooting

Problem What to do
Directory server type is not offered It is not available on your setup. Use Google, Microsoft 365 or SCIM, or contact 9bx support.
Someone was not created Open Log and read the reason. Check the mappings.
Nobody was switched off The source may be set to Do nothing, or a large switch-off is waiting for confirmation.