Turn on single sign-on (SSO) to allow your team members to login into Deputy via your company's identity provider (IdP). This means team members will only need to remember one password. Additionally, by using SSO you can ensure your team members can use and access Deputy securely.
In this article we will cover:
- How to enable SSO in Deputy
- Supported IDPs
- Setting up SSO in the Identity Provider
- Setting up SSO in Deputy
- Setting up Single Log Out (SLO) in Deputy
- Setting up Single Log Out (SLO) in Identity Provider
- Just-In-Time provisioning
- How to login to Deputy on the web using SSO
- How to log in to Deputy mobile app using SSO
How to enable SSO in Deputy
SSO is a feature available to Deputy Enterprise plans but before we begin, please ensure you are logged into Deputy as a user with either System Administrator or Advisor access level.
Go to the Enterprise tab and under General Settings, click Single sign-on settings.
Supported Identity Providers
You will need to use an identity provider that supports SAML 2.0.
Deputy supports, but is not limited to, the following IdP Providers:
- Microsoft Azure
- Oracle Identity Management
Setting up SSO in the Identity Provider
- Go to your identity provider's site and follow the instructions to configure SSO
- The Single Sign-On URL or Login URL or Assertion Consumer Service URL should be:
your deputy subdomain + /exec/devapp/samlacs.php
- Download the public certificate (X.509 certificate) from your IdP
Setting up SSO in Deputy
- You will need the following information from your Identity Provider to configure SSO in Deputy:
- Identity Provider login (SSO) URL
- Identity Provider Issuer / Entity ID
- X.509 certificate (downloaded from the Identity Provider)
- Paste the above information to the following fields in the SSO settings in the Deputy web app in Single Sign-On Settings (Enterprise).
Setting up Single Log Out (SLO) in Deputy
1. Download the 'Deputy public certificate' (X.509 certificate) from the Deputy SSO settings and paste the certificate into your IdP setup.
Setting up Single Log Out (SLO) in the Identity Provider
You will need the following information from Deputy to configure SLO in the IdP:
Service Provider logout (SLO) URL:
your deputy subdomain + /exec/devapp/saml-slo
Service Provider Issuer / Entity ID
Upload the X.509 certificate (downloaded from Deputy)
Choose whether you want to make SSO optional or required
Making SSO required for your team members ensures the following:
- For mobile and web users: Prevents team members from using the supplied email address as set up in the SSO provider with other Deputy accounts
- Team members need to be authenticated by your company's IdP to access the Deputy account
- Your team must log in to Deputy with SSO. They won't be able to create or use a Deputy password to log in.
Warning: Do NOT tick this check box to require SSO to log in until you have tested that your SSO configuration works and you can successfully log in via SSO. Otherwise, if your SSO configuration is not correct, you will be locked out of your account and will have to contact Deputy Support to unlock your account.
Once you have tested your SSO configuration and are ready to require your team members to log in via SSO only then please tick the check box and click Apply changes when done.
Just-in-time (JIT) provisioning
Similar to our payroll and HR employee sync, we can add users into Deputy when they are added in your IdP.
Using JIT provisioning eliminates the need to create users in Deputy in advance.
- On the Single sign-on settings page, scroll down to the Just-in-time provisioning section and click the toggle to ON.
2. A number of fields will appear after toggling this to ON.
Mapping Deputy Attributes to your Identity Provider Attributes
You will need to map Deputy user attributes to the IdP user attributes.
In your IdP config, find the attribute values that match with the following:
- First name
- Last name
- Access level
Fill these in under 'Identity provider attribute'. These mappings will tell the IdP which user attribute values will populate into Deputy when provisioning users.
You have the option to choose the default value for Location and Access Level.
- Location will default to the first location created in the account.
- Access Level will default to the lowest access level, this is usually 'Employee'.
Mapping additional attributes
If you have more than one location and access level, you can map these as well.1. Select Map locations and/or Map access levels as required
1. Select Add new and a new field will appear.
2. Fill in that location's attribute (found in the IdP) and make sure it is accurate (case sensitive). If the IdP attribute isn't recognised or there's an error, it will be mapped to the default value.
3. Click Done to save changes.
Continue to map any other Locations or Access levels you need to complete.
Back in the main SSO settings page, once you are finished don't forget to click Apply Changes at the top of the page to make sure all changes are saved.
How to login to Deputy on the web using SSO
Log in to your Identity Provider (in this example, Okta) and click on the Deputy app to be automatically logged into Deputy.
How to log in to Deputy mobile app using SSO
1. To use SSO on mobile, you will need to provide your Deputy URL (subdomain) to your team members.
For example, if your URL is exampleurl.au.deputy.com, you will only need to send them exampleurl.au.
To learn how to change your URL, check out our help doc here.
3. After opening the app, tap Log in and then on the next screen tap on Single Sign On.
4. Your team members then need to type your organisation's URL provided in step 1 and tap on Continue.
5. Enter the credentials you need to log into your Identity Provider (in this example Okta) and then tap Sign in. You will be logged into Deputy.
Check out our FAQ guide for any questions on SSO.