The Foxpass Developer Hub

Welcome to the Foxpass developer hub. You'll find comprehensive guides and documentation to help you start working with Foxpass as quickly as possible, as well as support if you get stuck.

Get Started    API Reference

Sync with Okta

This describes how to set up Foxpass to sync your directory with Okta.

1. Create a new Okta user

It's under "Admin", then "Directory", then "Add Person".

Add a user named "Foxpass"

2. Make that user a read-only admin

Go to "Admin", then "Security", then "Administrators". Give the "Foxpass" user Read-Only admin rights.

3. Get that user's API key

Log into Okta as the Foxpass user we created in step 1. Generate an API key using the instructions from http://developer.okta.com/docs/api/getting_started/getting_a_token.

4. Enter your Okta credentials into Foxpass

Go to the Foxpass 'Sync' page. Click on the "Okta" tab. Choose 'Yes' from one or both of the dropdown menus, then enter your Okta site's URL and the API key you just generated and click "Save."

Optional: Enable Group Sync Whitelisting

If you have group sync enabled, you can whitelist which groups get imported during sync. This is useful for organizations that only want to import a subset of their groups used in Foxpass. Once group sync is enabled, you'll see a field to add any group prefixes for whitelisting. During the group sync process, any groups that do not begin with that prefix are not synced with Foxpass.

Optional: Enable User Whitelisting via Group Membership

If you have group sync enabled, you can whitelist users that belong to specific groups. This is useful for organizations that only want a subset of their directory to have access to Foxpass. Once group sync is enabled, you'll see a field to mark any groups for whitelisting. During the group sync process, any users that are not a member of one of those groups are automatically marked as "inactive."

Sync with Okta


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.


});