The easiest way for you to develop and verify your SCIM integration is to make use of an automated test suite that runs on Runscope.
If you are already familiar with Runscope, then import the OKTA SCIM Spec Test JSON API test (for SCIM 1.1 or SCIM 2.0) and configure the
SCIM Base URL variable to point at the base URL for your SCIM server, for example:
If you are not familiar with Runscope, follow the detailed instructions below to get started with using Runscope to test your SCIM server.
If you do not have a Runscope account already, we suggest starting with Runscope's free trial plan for Okta. Here is how to get started:
Now that you've imported Okta's SCIM test suite into Runscope, your next step will be to customize the test suite for the SCIM integration that you are writing.
After importing Okta's SCIM test suite into Runscope, you will need to configure the test for your SCIM integration. Here is how to do that:
You should be looking at the "API Tests" screen in Runscope, if not, click on the "Tests" tab on the top of Runscope's user interface.
You should see a test named "Okta SCIM 2.0 Tests", if not, follow the "Set up Runscope" steps above.
Move your mouse over the "Okta SCIM 2.0 Tests" test, then select the "Edit" link on the lower left of the test.
In the "Environment" section of your test, you should see a collapsed "Test Settings" section, click the arrow on the left of "Test Settings" to expand this section.
"Initial Variables" should be selected, click the "Add Initial Variable" link and add the following:
|Variable Name (Case Sensitive)||Example Values||Notes|
|SCIMBaseURL|| ||For example, if your SCIM integration is hosted on https://example.com and uses a prefix of /scim/v2 then the "SCIM Base URL" for your integration would be: |
|auth||Bearer abcxyz1234567890||Basic/Oauth authorization values|
Add the Initial Script Spec. If you are developing your SCIM integration in a local development environment, we suggest using the excellent tool ngrok to expose your local development environment to Runscope.
Click the "Save" button at the top of the test.
Now that you have updated your SCIM test in Runscope for your SCIM server, it is time to run the test:
As you are developing your SCIM server, you will likely want to share test results with teammates or with Okta.
Here is how to share a test result from Runscope with someone else:
Once you have a SCIM server that passes all of the Runscope tests, test your SCIM integration directly with Okta. To do so, you will first need to sign up for an Okta developer account.
Note: If you are using OAuth Authorization Code Grant flow as your authentication method or need to support the Profile Master action, Okta will need to custom-configure a template app for you. Please request this in your email to email@example.com.
Navigate to the administrator interface in your Okta org by clicking Admin.
Click Applications, then Add Application.
Search for "SCIM". You'll see three different SCIM template applications for each SCIM version (1.1 and 2.0) based off of the various authentication methods you could choose to support (Header Auth, Basic Auth, or Bearer Token).
Your QA team should test the use cases in this downloadable spreadsheet: Okta SCIM Test Plan.Next: