Sync user accounts from Google Workspace to Apple School Manager
You can sync user accounts from Google Workspace into Apple School Manager. When this occurs, you merge Apple School Manager properties (such as year level and roles) with user account data imported from Google Workspace. The account information is added as read-only until you turn off syncing. At that time, the accounts become manual accounts, and attributes in these accounts can then be edited.
The initial sync takes longer to perform than subsequent cycles.
Note: Syncing user groups is not supported.
Before you begin
Before you sync to Google Workspace using an OIDC connection, you must do the following:
If necessary, configure and verify the domain you want to use. See Link to new domains. If you have already verified the domain you want to federate with Google Workspace, you can skip this process.
Disconnect from your Student Information System (SIS) or stop uploads using SFTP.
Configure, federate and enable a domain. See Use federated authentication with Google Workspace.
Have on call a Google Workspace administrator with permissions to edit Google Workspace settings.
Google Workspace user accounts and Apple School Manager
When a user account is synced from Google Workspace to Apple School Manager, the default role is Student. After the sync is complete, the following user attributes can be edited:
roles
academic year level
Student Information System (SIS) username
These attributes are stored with the user account in Apple School Manager and are not written back to Google Workspace.
Sign-in attribute
Apple School Manager requires that the attribute used for the Managed Apple ID be unique. This is normally the user’s email address. If a user has an attribute that is exactly the same as an existing Apple School Manager user with the role of Administrator, no syncing is performed and the source field remains unchanged.
Person ID
When a Google Workspace user account is synced to Apple School Manager, a Person ID is created for the Apple School Manager user account. The Person ID is used to identify conflicting user accounts.
Important considerations if you modify the Person ID:
If you modify the Person ID for a user account previously imported from Google Workspace, that user account is no longer paired with Google Workspace.
If you modify the Person ID for a user account previously imported from Google Workspace and want to reconnect the user account, you must resolve the conflict.
Turn on Google Workspace Sync
In Apple School Manager
, sign in as a user that has the role of Administrator, Site Manager or People Manager.Select your name at the bottom of the sidebar, select Preferences
, then select Managed Apple IDs
.Under Directory Sync, turn on Google Workspace Sync.
Manually sync
You can manually sync Apple School Manager to Google Workspace to import any changes made in Google Workspace.
In Apple School Manager
, sign in as a user that has the role of Administrator, Site Manager or People Manager.Select your name at the bottom of the sidebar, select Preferences
, then select Managed Apple IDs.Select Sync Now under Google Workspace Sync.