Tutorial: Configure Smartsheet for automatic user provisioning
The objective of this tutorial is to demonstrate the steps to be performed in Smartsheet and Azure Active Directory (Azure AD) to configure Azure AD to automatically provision and de-provision users and/or groups to Smartsheet. For important details on what this service does, how it works, and frequently asked questions, see Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory.
- Create users in Smartsheet
- Remove users in Smartsheet when they do not require access anymore
- Keep user attributes synchronized between Azure AD and Smartsheet
- Single sign-on to Smartsheet (recommended)
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
- An Azure AD tenant.
- A user account in Azure AD with permission to configure provisioning (e.g. Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
- A Smartsheet tenant.
- A user account on a Smartsheet Enterprise or Enterprise Premier plan with System Administrator permissions.
- System Admins and an IT Administrator can set up Active Directory with Smartsheet
Step 1. Plan your provisioning deployment
- Learn about how the provisioning service works.
- Determine who will be in scope for provisioning.
- Determine what data to map between Azure AD and Smartsheet.
Step 2. Configure Smartsheet to support provisioning with Azure AD
Before configuring Smartsheet for automatic user provisioning with Azure AD, you will need to enable SCIM provisioning on Smartsheet.
Sign in as a System Admin in the Smartsheet portal and navigate to Account > Admin Center.
In the Admin Center page click on the Menu option to expose the Menu panel.
Navigate to Menu > Settings > Domains & User Auto-Provisioning.
To add a new domain click on Add Domain and follow instructions.Once the domain is added make sure it gets verified as well.
Generate the Secret Token required to configure automatic user provisioning with Azure AD by navigating Smartsheet portal and then navigating to Account > Apps and Integrations.
Choose API Access. Click Generate new access token.
Define the name of the API Access Token. Click OK.
Copy the API Access Token and save it as this will be the only time you can view it. This is required in the Secret Token field in Azure AD.
Step 3. Add Smartsheet from the Azure AD application gallery
Add Smartsheet from the Azure AD application gallery to start managing provisioning to Smartsheet. If you have previously setup Smartsheet for SSO you can use the same application. However it is recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery here.
Step 4. Define who will be in scope for provisioning
The Azure AD provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described here.
Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an attribute based scoping filter.
To ensure parity in user role assignments between Smartsheet and Azure AD, it is recommended to utilize the same role assignments populated in the full Smartsheet user list. To retrieve this user list from Smartsheet, navigate to Account Admin > User Management > More Actions > Download User List (csv).
To access certain features in the app, Smartsheet requires a user to have multiple roles. To learn more about user types and permissions in Smartsheet, go to User Types and Permissions.
If a user has multiple roles assigned in Smartsheet, you MUST ensure that these role assignments are replicated in Azure AD to avoid a scenario where users could lose access to Smartsheet objects permanently. Each unique role in Smartsheet MUST be assigned to a different group in Azure AD. The user MUST then be added to each of the groups corresponding to roles desired.
If you need additional roles, you can update the application manifest to add new roles.
Step 5. Configure automatic user provisioning to Smartsheet
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in Smartsheet based on user and/or group assignments in Azure AD.
To configure automatic user provisioning for Smartsheet in Azure AD:
Sign in to the Azure portal. Select Enterprise Applications, then select All applications.
In the applications list, select Smartsheet.
Select the Provisioning tab.
Set the Provisioning Mode to Automatic.
Under the Admin Credentials section, input the SCIM 2.0 base URL of
https://scim.smartsheet.com/v2and Access Token value retrieved earlier from Smartsheet in Secret Token respectively. Click Test Connection to ensure Azure AD can connect to Smartsheet. If the connection fails, ensure your Smartsheet account has SysAdmin permissions and try again.
In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications and check the checkbox - Send an email notification when a failure occurs.
Under the Mappings section, select Synchronize Azure Active Directory Users to Smartsheet.
Review the user attributes that are synchronized from Azure AD to Smartsheet in the Attribute Mapping section. The attributes selected as Matching properties are used to match the user accounts in Smartsheet for update operations. Select the Save button to commit any changes.
Attribute Type Supported for filtering userName String ✓ active Boolean title String name.givenName String name.familyName String phoneNumbers[type eq "work"].value String phoneNumbers[type eq "mobile"].value String phoneNumbers[type eq "fax"].value String emails[type eq "work"].value String externalId String roles String urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department String urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division String urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter String urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager String
To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.
To enable the Azure AD provisioning service for Smartsheet, change the Provisioning Status to On in the Settings section.
Define the users and/or groups that you would like to provision to Smartsheet by choosing the desired values in Scope in the Settings section.
When you are ready to provision, click Save.
This operation starts the initial synchronization of all users and/or groups defined in Scope in the Settings section. The initial sync takes longer to perform than subsequent syncs, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running.
Step 6. Monitor your deployment
Once you've configured provisioning, use the following resources to monitor your deployment:
- Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully
- Check the progress bar to see the status of the provisioning cycle and how close it is to completion
- If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states here.
- Smartsheet does not support soft-deletes. When a user's active attribute is set to False, Smartsheet deletes the user permanently.
- 06/16/2020 - Added support for enterprise extension attributes "Cost Center", "Division", "Manager" and "Department" for users.
- 02/10/2021 - Added support for core attributes "emails[type eq "work"]" for users.
- 02/12/2022 - Added SCIM base/tenant URL of
https://scim.smartsheet.com/v2for SmartSheet integration under Admin Credentials section.
- Managing user account provisioning for Enterprise Apps
- What is application access and single sign-on with Azure Active Directory?
Submit and view feedback for