Use 探花大神 SAML Single Sign On (SSO) to give your users convenient but secure access to all their web applications with a single set of credentials. Automatically provision, update and deprovision users in Dialpad from 探花大神 using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in 探花大神 for Dialpad. Save time and avoid mistakes, as well as potential security risks, related to manually creating users.
Read this article to learn how to setup the Dialpad integration.
Prerequisites
- 探花大神 Administrator account
- 探花大神 SSO Package or higher or SSO 脿 la carte option
- A Dialpad user account with administrator permissions
- Dialpad Enterprise plan, your Dialpad Service Provider ID and Domain name
- 聽to have @jumpcloud.com聽added聽as a secondary domain in the company CSR. SCIM will fail otherwise
Important Considerations
- SCIM requires SAML 2.0 SSO to be configured.
- Dialpad SCIM API is based on version 2.0 of the SCIM standard.
- If you need to update the SCIM token, you must deactivate the IdM integration, update the token, and then reactivate the integration.
- Groups are not supported.
Attribute Considerations
- A default set of attributes are managed for users. See the Attribute Mappings section for more details.
Creating a new 探花大神 Application Integration
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Click + Add New Application.
- Type the name of the application in the Search field and select it.
- Click Next.
- In the Display Label, type your name for the application. Optionally, you can enter a Description, adjust the User Portal Image and choose to hide or Show in User Portal.
- Optionally, expand Advanced Settings to specify a value for the SSO IdP URL. If no value is entered, it will default to https://sso.jumpcloud.com/saml2/<applicationname>.
The SSO IdP URL is not editable after the application is created. You will have to delete and recreate the connector if you need to edit this field at a later time.
- Click Save Application.
- If successful, click:
- Configure Application and go to the next section
- Close to configure your new application at a later time
Configuring the SSO Integration
To configure 探花大神
- Create a new application or select it from the Configured Applications list.
- Select the SSO tab.
- Replace any instances of SERVICE_PROVIDER_ID/YOUR_DOMAIN with your Dialpad information.
- Add or change any attributes.
- Click save.
Download the certificate
- Find your application in the Configured Applications list and click anywhere in the row to reopen its configuration window.
- Go to SSO tab > Actions > Download certificate.
The certificate.pem will download to your local Downloads folder.
To configure Dialpad
- Login your Dialpad account as an administrator.
- Navigate to Admin Settings > My Company > Authentication > SAML, then select Custom from the provider dropdown menu.
- Enter the following information:
- IdP Entity ID - copy and paste the 探花大神 Entity ID.
- IdP SSO URL - copy and paste the 探花大神 IDP URL.
- Certificate - copy and paste the contents of the certificate downloaded in the previous section.
- Click Save.
Authorizing User SSO Access
Users are implicitly denied access to applications. After you connect an application to 探花大神, you need to authorize user access to that application. You can authorize user access from the Applications, Users List or User Groups 辫补驳别.听
To authorize user access from the Application’s page
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications, then select the application to which you want to authorize user access.
- Select the User Groups tab. If you need to create a new group of users, see Get Started: User Groups.
- Select the check box next to the desired group of users to which you want to give access.
- Click Save.听
To learn how to authorize user access from the聽Users or User Groups聽pages, see聽Authorize Users to an SSO Application.
Validating SSO user authentication workflow(s)
IdP-initiated user workflow
- Access the
- Go to聽Applications and click an application tile to launch it
- 探花大神 asserts the user's identity to the SP and is authenticated without the user having to log in to the application
SP-initiated user workflow
- Go聽to the SP application login - generally, there is either a special link or an adaptive username field that detects the user is authenticated through SSO
This varies by SP.
- Login redirects the user to 探花大神 where the user enters their 探花大神 credentials
- After the user is logged in successfully, they are redirected聽back to the SP and automatically logged in
Configuring the Identity Management Integration
To configure Dialpad
- Configure or ensure SSO is setup between Dialpad and 探花大神.
- As a Dialpad administrator, navigate to Admin Settings > My Company > Authentication> API keys.
- Click on Add key and generate a new API key for 探花大神 with the default scopes (already selected).
The Client ID and Secret (token) may only be shown once. Copy them to a secure location, like the 探花大神 Password Manager, for future reference.
- For the SCIM integration to succeed, 探花大神 will try to create a test user with a @jumpcloud.com domain. Ensure this has been added as a secondary domain in the company CSR before proceeding further. to have this enabled.
To configure 探花大神
- Create a new application or select it from the Configured Applications list.
- Select the Identity Management tab.
- Click Configure and paste the token in the Token Key field.
- Click activate and then click save.
- You will receive a confirmation that the Identity Management integration has been successfully verified.
- You can now connect user groups to the application in 探花大神 to provision the members of that group in Dialpad. Learn how to Authorize Users to an Application.
Attribute Mappings
The following table lists attributes that 探花大神 sends to the application. See Attribute Considerations for more information regarding attribute mapping considerations.
Learn about 探花大神 Properties and how they work with system users in our .
探花大神 Property | 探花大神 UI Field Name | SCIM v2 Mapping | Dialpad Value |
---|---|---|---|
username | Username | userName | IdP Username |
Company Email | emails:value | ||
firstname | First Name | name.givenName | First Name |
lastname | Last Name | name.familyName | Last Name |
department | Department | department | Department |
active | Status | active | active |
phoneNumbers.value | Work Phone | phoneNumbers.value | phoneNumbers.value |
addresses.country | Work Country | addresses.country | addresses.country |
preferredLanguage | preferredLanguage | preferredLanguage | preferredLanguage |
employeeidentifier | Employee ID | externalId | externalId |
Importing Users
This functionality is helpful if users have already been created in the application聽but have not been created in 探花大神.
Users that are suspended in the application will not be created in 探花大神.
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application and click to open its configuration panel.
- Select the Identity Management tab.
- Click manual import.
- Select the users you want to create in 探花大神 from the application from the list of users that appear. Users in the list have two import statuses:
- New - user has not been imported
- Imported - user has been imported and has an account in 探花大神
Tip: Try using the New Users-only filter when selecting users to import. This will move all of your new users to the top of the list, making them easier to identify and select.
- Click import.
- If you are importing less than 100 users, your import results will display in real time and you can continue onboarding your users
- If you have more than 100 users being imported, 探花大神 will send you an email when your import is complete
- You can now connect and grant users access to all their 探花大神 resources. Learn more in the Authorize Users to an Application and Connecting Users to Resources articles.
Warning: Imported users must be members of a user group bound to an application for 探花大神 to manage their identity in, and access to, the application.
SCIM Directory Insights Events
The following Directory Insights (DI) events provide visibility into failures and detailed information about the user and group data being added or updated from HR or other external solutions to 探花大神.
Customers with no package or the Device Management Package will need to add the Directory Insights 脿 la carte option. Directory Insights is included in all other .
SCIM DI Integration Events
Event Name | Event Description |
---|---|
idm_integration_activate | Logged when an IT admin attempts to activated new SCIM Identity Management integration. |
idm_integration_update | Logged when an IT admin attempts to update a configured and activated SCIM Identity Management integration. |
idm_integration_reauth | Logged when an IT admin attempts to change the credentials for an activated SCIM Identity Management integration. |
idm_integration_delete | Logged when an IT admin attempts to deactivate an activated SCIM Identity Management integration. |
SCIM DI User Events
Event Name | Event Description |
---|---|
user_create_provision | Logged when 探花大神 tries to create a new user in service provider application. |
user_update_provision | Logged when 探花大神 tries to update an existing user in service provider application. |
user_deprovision | Logged when 探花大神 tries to change an existing user to inactive in the service provider application. |
user_delete_provision | Logged when 探花大神 tries to delete an existing user in service provider application. |
user_lookup_provision | Logged when 探花大神 encounters an issue when trying to lookup a user to determine if the user needs to be created or updated. |
SCIM DI Group Events
These DI events will only be present if SCIM Groups are supported.
Event Name | Event Description |
---|---|
group_create_provision | Logged when 探花大神 tries to create a new group in service provider application. |
group_update_provision | Logged when 探花大神 tries to update an existing group in service provider application. |
group_delete_provision | Logged when 探花大神 tries to delete an existing group in service provider application. |
Removing the Integration
These are steps for removing the integration in 探花大神. Consult your SP's documentation for any additional steps needed to remove the integration in the SP. Failure to remove the integration successfully for both the SP and 探花大神 may result in users losing access to the application.
To deactivate the IdM Integration
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you鈥檇 like to deactivate and click to open its details panel.
- Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
- Click confirm.
- If successful, you will receive a confirmation message.
To deactivate the SSO Integration or Bookmark
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you鈥檇 like to deactivate and click to open its details panel.
- Select the聽SSO or Bookmark聽tab.
- Scroll to the bottom of the configuration.
- Click Deactivate SSO or Deactivate Bookmark.
- Click save.
- If successful, you will receive a confirmation message.
To delete the application
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you鈥檇 like to delete.
- Check the box next to the application to select it.
- Click Delete.
- Enter the number of the applications you are deleting
- Click Delete Application.
- If successful, you will see an application deletion confirmation notification.