How to Configure Directory Sync
Zuddl's directory sync feature allows your organization to synchronize users from your internal directory directly into Zuddl, ensuring accurate role assignments and access controls. Using directory sync, users and their roles are automatically kept up-to-date in Zuddl. If you have groups in your organization to assign users roles and manage accessibility, they can be automatically kept up-to-date in Zuddl by mapping a custom Zuddl attribute, "zuddl_role," for easy role-based access management.
Prerequisite
The directory sync can be configured only if Single Sign-On (SSO) is configured for your Zuddl organization. Learn how to setup SSO for your Zuddl organization.
Setting up Directory Sync
The setup involves:
- Enable directory sync in Zuddl
- Mapping custom role attribute
- Validating role values
- Testing sync
Enable directory sync
- To configure directory sync, click on the Configure directory option from the dropdown.
This option appears only after setting up SSO. Learn how to set up SSO for your Zuddl organization. - Select your directory provider from the list. You can also search for your IDP from the search bar.
- Follow the instructions to set up the directory sync.
Map the custom role attribute
In order for users to be given the required access, their roles must be mapped from your directory to Zuddl roles. For example, owner, admin, members organization-level roles.
If your IDP supports groups, you can assign users to groups and map them to specific roles on Zuddl. If your IDP does not support groups, you must add a custom attribute for each user in your IDP and map that custom attribute with a specific Zuddl role. This can be done in the 3rd step. You can choose the desired attribute name, but the attribute value must be the same as given in the table below.
Role Mapping and Supported Attribute Values
To assign roles, map a custom attribute in your directory to "zuddl_role" in Zuddl.
The following values define user permissions:
Directory role | Attribute value | Definition | Zuddl role (Initial sync ) |
---|---|---|---|
Owner | owner | Full administrative access to all features and settings. | Organizer |
Admin | admin | Administrative privileges, though not ownership. | Organizer |
Member | member | Standard user permissions with setup limitations. | Moderator |
Attendee | attendee | Event access only, no setup permissions (default role). | Not shown in the Zuddl role list |
Namespace to be used for the custom attribute:
urn:ietf:params:scim:schemas:core:2.0:User
- Users synced from your directory cannot have their roles changed through the Zuddl dashboard. Modifications must be made directly in your directory by updating the Zuddl app's user or role assignments.
- Users synced from your directory cannot be removed through the Zuddl dashboard. Removing or adding the user from your IDP will also remove you from the member's list in Zuddl.
If you've added a user from your IDP SSO and are not showing on the setup side, remove the user and add them again
If directory sync is disconnected, Zuddl will retain all previously synced users, allowing for role changes and user management through the Zuddl dashboard from that point forward.
The initial assignment for the Moderator role can be changed only from the directory.
Once the directory is successfully connected, it shows the following screen
The added user appears on the members list for your team in Zuddl
Validate role values
Ensure that each user's role aligns with one of the supported Zuddl values.
After the directory settings are complete, the edit dropdown button shows the following options:
Test Sync
After mapping, run a test sync to confirm accurate user and role assignments. You should also review synced users in the Zuddl admin interface to confirm roles are correctly mapped.
Syncing members
If the syncing of members has not happened from your IDP, you can click the sync button here. Please only use when some members that you added do not appear here.
The more option for members that were added via SSO only shows the Manage team access option.
Verify the role mapping to ensure all role values match supported options and at least one of the two role assignment methods - group based or custom attribute based is configured.