Streamline lifecycle management for your organization by connecting Okta with ºÚÁϺ£½Ç91Èë¿Ú through a Real-time User and Password Import SCIM integration. This integration lets you manage your organization’s user identities in Okta, and easily connect users to all of the IT resources they need through ºÚÁϺ£½Ç91Èë¿Ú. After you connect Okta with ºÚÁϺ£½Ç91Èë¿Ú through SCIM, depending on the integration settings you choose, users are seamlessly created, updated, and deactivated in ºÚÁϺ£½Ç91Èë¿Ú according to the actions you take on users in Okta.
Supported Features
The following SCIM actions are supported for Okta’s User Import and Password Mastery integration with ºÚÁϺ£½Ç91Èë¿Ú.
- User import: Users accounts are imported from Okta into ºÚÁϺ£½Ç91Èë¿Ú
- Password sync: User account passwords are synchronized between Okta and ºÚÁϺ£½Ç91Èë¿Ú; changes made to passwords in Okta are synced with ºÚÁϺ£½Ç91Èë¿Ú
- Create: When you create users in Okta they’re created in ºÚÁϺ£½Ç91Èë¿Ú
- Update: When you update user attributes in Okta, these updates are reflected in ºÚÁϺ£½Ç91Èë¿Ú
Read the Considerations for more detail on this feature.
- Deactivate:ÌýWhen you deactivate or delete a user in Okta, the user is placed in a suspended state in ºÚÁϺ£½Ç91Èë¿Ú
Prerequisites
- You needÌýUser ProvisioningÌýfunctionality enabled for your Okta account.ÌýLearn aboutÌý
- You need a ºÚÁϺ£½Ç91Èë¿Ú API Key (see instructions below)
Recommendations
- To prevent end-user access issues, we recommend that you use the same password complexity requirements as Okta, seeÌýManage Password and Security Settings
- Consider choosingÌýnot to expire ºÚÁϺ£½Ç91Èë¿Ú account passwords. If you choose to enforce password aging for your ºÚÁϺ£½Ç91Èë¿Ú account passwords, be mindful of the expiration dates for users you’re managing for Okta. SeeÌýManage Password and Security Settings to learn more about password aging
- We also recommend that you create a ºÚÁϺ£½Ç91Èë¿Ú admin service account to generate the API Key you need to connect ºÚÁϺ£½Ç91Èë¿Ú with Okta. This service account shouldn’t be tied to a specific user’s email address. For added security,Ìýyou canÌýrequire Multi-factor Authentication atÌýlogin for this admin service account. SeeÌýManage Admin Accounts to learn more
Considerations
- ​​​​​If you update a user name in Okta for a user that is bound to resources, it won'tÌýupdate that user's username in ºÚÁϺ£½Ç91Èë¿Ú. However, if that user isn't bound to any resources in ºÚÁϺ£½Ç91Èë¿Ú, then it will change the user's username.​
- When a user is associated with the ºÚÁϺ£½Ç91Èë¿Ú application in their Okta account, a couple of things happen:
- Their password is sent to ºÚÁϺ£½Ç91Èë¿Ú when it is changed in Okta
- OnceÌýthey've been associated with ºÚÁϺ£½Ç91Èë¿Ú, they log in to their Okta account for the first time after the association, and the passwords will beÌýsynced
- If you are trying to have an existing user's account managed by ºÚÁϺ£½Ç91Èë¿Ú, the usernames must meet specific requirements:
- Important: The user can't be bound to any resources at the time of account takeover.
- The username in Okta is an email, however in ºÚÁϺ£½Ç91Èë¿Ú the username is not an email.
- To have ºÚÁϺ£½Ç91Èë¿Ú manage a user's account, the email used in Okta prefix (everything before the @ symbol) needs to match the username in ºÚÁϺ£½Ç91Èë¿Ú
- For example, if the email is [email protected], then the username in ºÚÁϺ£½Ç91Èë¿Ú needs to be john.doe.
- To have ºÚÁϺ£½Ç91Èë¿Ú manage a user's account, the email used in Okta prefix (everything before the @ symbol) needs to match the username in ºÚÁϺ£½Ç91Èë¿Ú
- If you are trying to have a new user's account managed by ºÚÁϺ£½Ç91Èë¿Ú, the username has specifications that will result in a failure if not met. The requirements are:
- The username needs to start with a letter
- It needs to be 30 characters or less
- These can only include valid unix characters (letters, numbers, hyphens ' - ,' periods ' . ,' and underscores ' _ .')
- If a password is changed directly from the user console it clears the credential manager on a Windows device. This is also the case when a user is externally managed and password updates come from a 3rd party, like Okta
Known Issues:
- After you import users from Okta, users and their attributes are synced between ºÚÁϺ£½Ç91Èë¿Ú and Okta. The users that you import from Okta are fully editable in ºÚÁϺ£½Ç91Èë¿Ú in both the Admin and User Portals. This means that users can change their password and user attributes in the ºÚÁϺ£½Ç91Èë¿Ú User Portal. If a user updates their password in the User Portal, it can be overwritten by Okta, potentially placing the user in a bad state. We recommend that you disable the ability for users to update their user attributes in the ºÚÁϺ£½Ç91Èë¿Ú User Portal. You can do this in the Admin Portal’sÌýGeneral Information Org Settings. If you disable your end users’ ability to modify their user attributes in the User Portal, admins are still able to modify end-user attributes in the ºÚÁϺ£½Ç91Èë¿Ú Admin Portal. Learn more about this feature inÌýSettings in the ºÚÁϺ£½Ç91Èë¿Ú Admin PortalÌý
- If you manage end-users devices with ºÚÁϺ£½Ç91Èë¿Ú and integrate Okta with ºÚÁϺ£½Ç91Èë¿Ú, passwords can become out of sync between Okta and ºÚÁϺ£½Ç91Èë¿Ú if a user changes their password through their device. You can leverage Okta integration with ºÚÁϺ£½Ç91Èë¿Ú managed devices by keeping the following in mind:
- macOS:ÌýºÚÁϺ£½Ç91Èë¿Ú's Menu Bar App prompts users to confirm their password if they become out of sync when they're provisioned to ºÚÁϺ£½Ç91Èë¿Ú from OktaÌý
- To see more detailed information seeÌýManaging Password Resets with Okta and ºÚÁϺ£½Ç91Èë¿Ú Managed DevicesÌýbelow
Attribute Mappings:
The following table lists attributes that ºÚÁϺ£½Ç91Èë¿Ú can receive from Okta.
Learn about ºÚÁϺ£½Ç91Èë¿Ú Properties and how they work with systemusers in our .
Okta Attribute Name | ºÚÁϺ£½Ç91Èë¿Ú Attribute Name | Notes |
---|---|---|
login | userName |
For this attribute to map correctly, this attribute has been updated to |
user.firstName | givenName | |
user.lastName | familyName | |
user.middleName | middleName | |
user.email | ||
user.emailType | emailType |
For this attribute to map correctly, this attribute has been updated to |
user.Title | title | |
user.displayName | displayName | |
user.displayName | primaryPhone | |
user.primaryPhoneType | primaryPhoneType |
For this attribute to map correctly, this attribute has been updated to |
user.addressType | addressType |
For this attribute to map correctly, this attribute has been updated to |
user.streetAddress | streetAddress | |
user.city | locality | |
user.state | region | |
user.zipCode | postalCode |
Getting Your API Key in ºÚÁϺ£½Ç91Èë¿Ú
You need a ºÚÁϺ£½Ç91Èë¿Ú API Key to connect Okta and ºÚÁϺ£½Ç91Èë¿Ú. This key is found in the ºÚÁϺ£½Ç91Èë¿Ú Admin Portal.
The API key from MTP admins will not work with the ºÚÁϺ£½Ç91Èë¿Ú integration app in Okta. Only the tenant specified admin's key will work in this integration.
To generate an API Key:
- Log in to the .
- Click your account initials displayed in the top-right and select My API Key from the drop down menu.
- If you haven't generated an API key before, click Generate API Key to have an API key generated and displayed. If you have an API key but don't have it stored, click Generate New API Key.
API Keys are only displayed at the time they’re created. Make sure to store it in a secure place, like ºÚÁϺ£½Ç91Èë¿Ú’s Password Manager so you can access it when you need it.
If you're generating a new API key, it will revoke access to the current API key. This will render all calls using the previous API key inaccessible. You will have to update any existing integrations that use an API key with the newly generated value. See ºÚÁϺ£½Ç91Èë¿Ú APIs to see the impacted integrations.
- Paste the key into Okta’s API integration settings.
Enabling and Configuring SCIM Integration in Okta
To enable and configure SCIM integration in Okta:
- Log in to Okta.
- Go to Applications, and open the ºÚÁϺ£½Ç91Èë¿Ú application.
- In the ºÚÁϺ£½Ç91Èë¿Ú application, go to General.
- For Application visibility, select the following options:
- Do not display application icon to users
- Do not display application in the Okta Mobile App
- Go to Provisioning, then click Configure API Integration.
- Select Enable API Integration.
- Paste the API Key that you copied from the ºÚÁϺ£½Ç91Èë¿Ú Administrator Portal.
- Click Test API Credentials, this isn't required, but recommended.
- If your optional test is successful, or if you choose not to test, click Save.
- Go to Provisioning > Settings > To App, then click Edit.
- (Required) Select Enable for the options you want to enable for your SCIM integration with ºÚÁϺ£½Ç91Èë¿Ú. You can choose to Create Users, Update User Attributes, and Deactivate Users.
- (Required) For Sync Password, select Enable and Sync Okta Password.
- Scroll past the Provisioning options, then click Save to apply your selected provisioning settings.
Verifying Your Integration
After you’ve integrated ºÚÁϺ£½Ç91Èë¿Ú with Okta, you can verify your integration by performing the following actions in Okta:
- Create a user: If you’re successfully integrated, when you create a user in Okta, the user is added in ºÚÁϺ£½Ç91Èë¿Ú and you'll see the user in the Users list
- Update a user: If you’re successfully integrated, when you update a user in Okta, the user is updated in ºÚÁϺ£½Ç91Èë¿Ú. You can verify the update by viewing the user's Details panelÌýÌý
- Suspend a user: If you’re successfully integrated, when you deactivate or delete a user in Okta, the user is suspended in ºÚÁϺ£½Ç91Èë¿Ú. You can verify the suspension by viewing the user in theÌýUsersÌýlist and by viewing theirÌýDetailsÌýpanel. SeeÌýSuspend and Restore User Accounts
Learn more about these actions and statuses in Getting Started: Users and User Account Status.
Troubleshooting Your Integration
If you run into issues during your verification of the integration, you can troubleshoot in the following ways:
- Check your provisioning selections: Make sure you selected the provisioning option for the action you’re performing. For example, make sure that you have selectedÌýUpdate User AttributesÌýif changes you’re making to users in Okta aren’t updating in ºÚÁϺ£½Ç91Èë¿Ú
- Check your sync password selection: Make sure you’ve selected theÌýSync Okta PasswordÌýoption forÌýSync PasswordÌý
Migration Steps
To create a new instance of ºÚÁϺ£½Ç91Èë¿Ú in Okta:
- Log in to your Okta org as an administrator.
- Select to view the Classic UI.
- Click Add Applications.
- Search for ºÚÁϺ£½Ç91Èë¿Ú, then select the application.
- Click Add.
- Configure the new application with provisioning as described in Enabling and Configuring SCIM Integration in Okta.
Managing Password Resets with Okta and ºÚÁϺ£½Ç91Èë¿Ú Managed Devices
In this configuration, Okta will export Users, attributes, and passwords to ºÚÁϺ£½Ç91Èë¿Ú through the OIN App. Passwords should be set or reset within Okta once this configuration has been enabled. ºÚÁϺ£½Ç91Èë¿Ú will receive these passwords from Okta when a user resets within their Okta user portal. If you are additionally leveraging ºÚÁϺ£½Ç91Èë¿Ú to manage your macOS, Windows, and Linux devices, you must consider the following to ensure that your users utilize and know the best practices for password resets.
With this integration, all passwords must be reset within Okta. If passwords are changed in ºÚÁϺ£½Ç91Èë¿Ú, they will not be exported back to Okta and will result in discrepancies between the user’s Okta and ºÚÁϺ£½Ç91Èë¿Ú passwords.
Managing Password Resets and ºÚÁϺ£½Ç91Èë¿Ú Managed MacOS Devices
There can be several workflows when resetting passwords within this configuration. When devices are managed by ºÚÁϺ£½Ç91Èë¿Ú, passwords should be reset in Okta and later confirmed on the device. Ensure that the following best practices are leveraged when users commit a password reset within Okta.
Additionally, ºÚÁϺ£½Ç91Èë¿Ú requires macOS devices to be online during the password change in Okta so that the device will receive the new password via the ºÚÁϺ£½Ç91Èë¿Ú Agent. This can be achieved when users are logged into their device and change the password within a browser window. The ºÚÁϺ£½Ç91Èë¿Ú Tray App then requests a confirmation of the password change. See the workflow diagrams below.
Password Reset with Okta and a Single MacOS Device (Online) - Recommended
In this diagram, a user resets their password in a browser window on their ºÚÁϺ£½Ç91Èë¿Ú managed macOS device. This sends the password to ºÚÁϺ£½Ç91Èë¿Ú which updates their ºÚÁϺ£½Ç91Èë¿Ú User Password. Within 60 seconds, their macOS ºÚÁϺ£½Ç91Èë¿Ú Device Agent checks in with ºÚÁϺ£½Ç91Èë¿Ú, receives the new password hash, and displays a notification. The User must confirm their password in order for the FileVault (SecureToken) password and User Login password to be synced within the macOS keychain.
Password Reset with Okta and a Single MacOS Device (Offline) - Not Recommended
ºÚÁϺ£½Ç91Èë¿Ú recommends that users change their passwords while logged in to their primary macOS device. If the user’s macOS device is offline, additional steps must be taken to ensure the password is updated in macOS. The workflow shown in the previous diagram is not recommended unless absolutely necessary.
When a user changes their password in Okta, while their macOS device is offline, Okta sends the updated password to ºÚÁϺ£½Ç91Èë¿Ú. ºÚÁϺ£½Ç91Èë¿Ú updates the user’s ºÚÁϺ£½Ç91Èë¿Ú password to the new Okta password. Because the macOS device is offline, no updates are received until FileVault is unlocked.
When the user cold-boots their macOS device, FileVault prompts for a password. The user must enter the previous password–that is, the one they used before the password reset in Okta. This is because the macOS device is encrypted, the NIC is not initialized, and the ºÚÁϺ£½Ç91Èë¿Ú Agent is not active until FileVault is unlocked.
Once the user has unlocked FileVault using their previous password, the ºÚÁϺ£½Ç91Èë¿Ú Device Agent will run, connect to the internet, and receive the new password hash from ºÚÁϺ£½Ç91Èë¿Ú. The user will see a second login prompt asking them for their previous and new password. The user should use the previous password they just used to unlock the Filevault Window and the new password they’ve just reset in Okta.
If typed correctly, the user is then logged into their profile and the macOS keychain is synced and updated appropriately.
Password Reset with Okta and Multiple MacOS Devices (Online) - Recommended
In the diagram above, a user resets their password within a browser window on their primary ºÚÁϺ£½Ç91Èë¿Ú managed macOS device. This sends the password to ºÚÁϺ£½Ç91Èë¿Ú which updates their ºÚÁϺ£½Ç91Èë¿Ú User Password. Once their macOS ºÚÁϺ£½Ç91Èë¿Ú Device Agent checks in with ºÚÁϺ£½Ç91Èë¿Ú, it receives the new password hash and displays a notification. The user must confirm their password in order for the FileVault (SecureToken) password and User Login password to be synced in the macOS keychain.
For the second macOS device, the user performs a login where the User Login prompt requests their previous and new password. This updates the macOS keychain to utilize the new password appropriately.
ºÚÁϺ£½Ç91Èë¿Ú recommends that the second or additional macOS devices be online and past the FileVault Login so the ºÚÁϺ£½Ç91Èë¿Ú Device agent and the NIC are active and initialized. It is not recommended to have the additional macOS devices offline during a password reset operation in Okta.
Password Reset with Okta and Multiple MacOS Devices (Online/Offline) - Not Recommended
ºÚÁϺ£½Ç91Èë¿Ú recommends only using this workflow if it is absolutely necessary to ensure proper password syncing.
In the diagram above, a user resets their password within a browser window on their primary ºÚÁϺ£½Ç91Èë¿Ú managed macOS device. This sends the password to ºÚÁϺ£½Ç91Èë¿Ú which updates the ºÚÁϺ£½Ç91Èë¿Ú User Password. Once the macOS ºÚÁϺ£½Ç91Èë¿Ú Device Agent checks in with ºÚÁϺ£½Ç91Èë¿Ú, it receives the new password hash and displays a notification. The user must confirm their password in order for the FileVault (SecureToken) password and User Login password to be synced within the macOS keychain.
For the second macOS device, the user cold-boots their macOS device. FileVault will prompt for a password. This is the password the user used before the password reset in Okta. This is because the macOS device is encrypted, the NIC is not initialized, and the ºÚÁϺ£½Ç91Èë¿Ú Agent is not active until after FileVault is unlocked.
Once the User has unlocked FileVault using their previous password, the ºÚÁϺ£½Ç91Èë¿Ú Device Agent will run, connect to the internet, and receive the new password hash from ºÚÁϺ£½Ç91Èë¿Ú. The user will see a second login prompt asking for their previous and new passwords. The user should use the previous password they just used to unlock the Filevault Window and the new password they’ve just reset within Okta.
ºÚÁϺ£½Ç91Èë¿Ú recommends that the second or additional macOS devices be online and past the FileVault Login so the ºÚÁϺ£½Ç91Èë¿Ú Device agent and the NIC are active and initialized. It is always best practice to have the additional macOS devices online during a password reset operation in Okta.
Password Reset with Okta and Windows Devices
In the diagram above, a user resets their password within a browser window on their ºÚÁϺ£½Ç91Èë¿Ú managed Windows device. This sends the password to ºÚÁϺ£½Ç91Èë¿Ú which updates the ºÚÁϺ£½Ç91Èë¿Ú User Password. Once the ºÚÁϺ£½Ç91Èë¿Ú Device Agent checks in with ºÚÁϺ£½Ç91Èë¿Ú, it receives the new password hash and updates the local password hash within Windows. The next time Windows requests a password, it will be using the new password the user just set.
Password Reset with Okta and Linux Devices
In the diagram above, a user resets their password within a browser window on their ºÚÁϺ£½Ç91Èë¿Ú managed Linux device. This sends the password to ºÚÁϺ£½Ç91Èë¿Ú which updates their ºÚÁϺ£½Ç91Èë¿Ú User Password. Once the ºÚÁϺ£½Ç91Èë¿Ú Device Agent checks in with ºÚÁϺ£½Ç91Èë¿Ú, it receives the new password hash and updates the local password hash within Linux. The next time Linux requests a password, it will be using their new password they’ve just set.
Additional Resources:
Walk through a guided simulation for