On This Page
Build a SCIM provisioning integration overview
This guide series teaches you the steps required to build an Okta integration that uses SCIM to handle user provisioning.
- Prepare a SCIM API service.
- Connect the SCIM API service to Okta via an integration.
- Test your integration to make sure everything is working correctly.
What you need
- An Okta Developer Edition organization. Don't have one? Create one for free (opens new window).
- A SCIM Version 2.0 API design that supports the minimum feature set.
- Profile Sourcing activated in your org, if you intend to test this feature in your SCIM app integration (see Profile Sourcing activation to find out how to activate).
Whether you are an independent software vendor (ISV), an existing Okta customer, an IT systems administrator, or a developer new to Okta, you need to know how to set up and test your cloud-based application and API endpoints to successfully deploy an Okta integration using SCIM provisioning.
If you need more detail on the concepts behind lifecycle management with SCIM and Okta, see Understanding SCIM.
While many ISVs have custom APIs for managing user accounts, this guide assumes that you use the System for Cross-domain Identity Management (opens new window) (SCIM) protocol, an industry standard that supports all of the needed features for lifecycle provisioning. For more technical details on how you can take advantage of the SCIM API with Okta, see our SCIM Protocol reference.
Your Okta integration should use Single Sign-On (SSO) to initiate end-user authentication. Learn how to set up your integration with SSO in our Build a Single Sign-On (SSO) integration guide.
This guide series contains the following parts:
- Prepare your SCIM API service: Prepare a SCIM-compliant API server to host your SCIM service, and test it to make sure it is working correctly.
- Connect your SCIM API service to Okta: Create and configure SCIM integrations, and check the attributes and their corresponding mappings in the Okta console.
- Test your Okta SCIM integration: Test that your SCIM application can handle actual requests to create, read, update, and delete (CRUD) user profile information, and run through our Okta Integration Network (OIN) quality assurance test cases.
After working through these guides, and preparing and testing your SCIM integration, you may want to make it public. To do so, follow the steps in our Submit an app integration guide to have it published in the Okta Integration Network (OIN) catalog (opens new window).
Now that you know what these guides cover, you can get started by Preparing your SCIM API service.