To setup a Google Workspace for integration with Apteryx, a few settings must be configured.
Create custom Apteryx settings for users
Apteryx permissions are translated from custom attributes defined in a Google Workspace. To create a new custom attribute, go to Users → More options → Manage custom attributes.
Create a category called Apteryx Claims
the value type is Text
the field is Multi-value
Save these changes.
For each user in your Google Workspace, we must then assign a set of permissions for that user.
Click on Users → Select the user → User information → Scroll down to the Apteryx Claims category.
Assign permissions by adding a value the
ApteryxClaims
multi-value that corresponds with a permission set for Apteryx.
Below is a set of valid claim permissions that correlate to their respective Apteryx User Roles and Privileges. These values are not case-sensitive.
ApteryxAdmins
ApteryxQuery
ApteryxEdit
Apteryx Online Capture
ApteryxExport
ApteryxPrint
ApteryxShare
Create a new custom SAML app registration for Apteryx
After users have been configured with the appropriate permissions, we must then configure Apteryx as an app that can be signed into using this Google Workspace.
Go to Apps → Web and mobile apps → Add app → Add custom SAML app.
Set the App name field to Apteryx. You may optionally fill out the other fields.
Click Continue.
Click Download Metadata. This will download a GoogleIDPMetadata.xml file.
If you don't already have an open ticket regarding your switch to Google SSO, you can submit a new ticket here. Be sure to include the xml file in your communication.
Click Continue.
Under Service provider details, set the ACS URL and the Entity ID.
Example:
Given my Apteryx URL is mydentist.Apteryx.net
The ACS URL will be https://apteryx-sso.Apteryx.net/federation/gwrk-mydentist-Apteryx-net/Saml2/Acs
The Entity ID will be https://apteryx-sso.Apteryx.net/federation/gwrk-mydentist-Apteryx-net/Saml2
Note: The URLs are similar but the ACS URL must end in /Acs.
Click Continue.
Under Attribute mapping we must map our custom attribute category from earlier.
Click Add Mapping, select ApteryxClaims and set the App attributes to also be ApteryxClaims.
Group membership settings are optional and will not affect Apteryx integration.
Service Status
Set service status to ON for everyone (may vary by organization) to grant users access to service.
Article Version 1.4 3/18/2025