Streamline user lifecycle management for your organization by connecting any generic Service Provider (such as an HRIS provider or other user directory) with 探花大神 using 探花大神's SCIM API. This type of integration can enable real-time user data syncing from the Provider to 探花大神, automating user creations, updates, and suspensions in 探花大神 based on updates made in the Service Provider.
This integration lets you manage your organization鈥檚 user identities in the Service Provider, and easily connect users to all of the IT resources they need through 探花大神.
Prerequisites:
- A Service Provider that supports an integration to a SCIM API. (They must have a SCIM client)
- A Service Provider account with the appropriate level of permissions to connect to an external SCIM API
- A 探花大神 organization
- A 探花大神 Admin account with Administrator role access and API access enabled.
- We strongly recommend creating a separate admin account just for this integration. This will allow you to easily identify the actions taken by the integration and avoid breaking the integration if a person leaves or changes roles.
- A 探花大神 API key that will be used in the custom x api key header. Learn how to generate your API key below.
Considerations:
- Your Service Provider is where identities are sourced and serves as the 鈥渟ource of truth鈥 or "authority" for user attributes. Once that identity is in 探花大神, admins can manage access, authentication, and extend that identity to all 探花大神 managed resources.聽
- When a user is created in the Service Provider, they will be added in 探花大神 as a user with a pending password status. This means a user will need to establish and maintain their password within 探花大神. Imported users won鈥檛 automatically be sent an activation email upon creation.
- Currently, the API token doesn鈥檛 expire.
- The generic SCIM integration uses .
- The 探花大神 SCIM API is based on version 2.0 of the .
- Real-time Group import isn鈥檛 currently supported.
Attribute Considerations:
- Any attributes that have been selected within your Service Provider for export to 探花大神 will overwrite values existing in 探花大神 with each update that is triggered in the Service Provider.
- We recommend Administrators Enable read-only on the user鈥檚 portal profile page for all users in the Organization Settings within the 探花大神 admin portal, to prevent users and other administrators from updating attributes in 探花大神.
Generically Integrating with the 探花大神 SCIM Server
To integrate with the SCIM server:
- Log in to the .
- Click on your initials in the top right corner, then click API Settings to access your API Key.
- Copy this key to paste in the API Key/Secret Token field of your Service Provider later.
- Now, log into your Service Provider's administrator account.
- Every Service Provider will have a different way of accessing application integrations.
- You should look for a gallery of available applications to install, find or search for 探花大神 and install the application.
探花大神 isn鈥檛 listed in every Service Provider鈥檚 application gallery. If this is the case, you will need to create a custom application for 探花大神.
- If you create a new application, we recommend using a name like; Real-time 探花大神 Import, or something similar.
- Now, open the application dashboard. Each Service Provider will have different questions regarding the application, for example; which attributes do you want to send to 探花大神? Enable/Disable Single Sign On (SSO)? User Provisioning Settings etc... However, all of them will require a Tenant URL, and a 探花大神 API Key (also commonly known as a Secret Token).
- Tenant URL: For 探花大神 this is a SCIM based URL, https://api.jumpcloud.com/scim/v2
- API Key/Secret Token: A 探花大神 API key should be used to authorize this integration. The API key in 探花大神 is associated with an admin account. Use an admin account that has a role of Admin with Billing, Administrator, or Manager that will be a long lived admin account for your organization.
- From your Admin portal, click on your initials in the top right corner, then click API Settings to access your API Key.
- Copy/paste this key into the API Key/Secret Token field.
- You should receive a notification from your Service Provider that 探花大神 was saved/created successfully.
- To confirm this, go back to the Service Provider鈥檚 application gallery and confirm that your newly created application; 探花大神/Real -time 探花大神 Import is there.
- Make sure that all the other settings you want integrated with 探花大神 are set, including attribute mappings, provisioning, email notifications, group sync, Single Sign On (SSO) etc鈥
- Note: Take a look at the Attribute Mappings table below to see which attributes 探花大神 sends to Service Providers, because not all attributes are supported.
- Your integration is now established. If you go back to your 探花大神 Administrator console, go to USER MANAGEMENT > Users and refresh the page, you will see newly added users in a password pending state.
Connector Attribute Mappings
The following table lists attributes that the 探花大神 SCIM client will accept from this integration. Learn about 探花大神 Properties and how they work with systemusers in our .
探花大神 Property | 探花大神 UI | SCIM v2 Mapping | 探花大神 Validation | Type |
---|---|---|---|---|
username | Username | userName | required, no special characters, (max length 1024). note: email may not be used as username. Some integrations leverage the email substring for the username | string |
firstname | First Name | name.givenName | max length 1024 | string |
lastname | Last Name | name.familyName | max length 1024 | |
Company Email | emails: value (primary) | email, required, max length 1024 | string | |
displayName | Display Name | displayName | - | string |
password | password | password | subject to org settings | string |
!suspended && !passwordExpired |
N/A | active | - | boolean |
N/A | N/A | meta.created | - | string |
N/A | N/A | meta.lastModified | - | string |
jobTitle | Job Title | title | - | string |
department | Department |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:user:department |
- | string |
location | Location | locale | - | string |
costCenter | Cost Center | costCenter | - | string |
employeeType | Employee Type | userType | - | string |
company | Company | organization | - | string |
employeeIdentifier | Employee ID |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:user:employeeNumber |
- | string |