On this page

Test your Okta SCIM integration

This guide teaches you to how 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.

Scope of tests

This second suite of Runscope (opens new window) tests checks that your SCIM application can handle actual requests to create, read, update, and delete (CRUD) user profile information.

Note: Okta doesn't delete user profiles in your application, but instead marks the user record with active=false to deactivate them. For a detailed explanation on deleting user profiles, see Delete (Deprovision).

Profile Sourcing activation

The Profile Sourcing capability (formerly known as Profile Mastering) must be activated for developer orgs by Okta Developer Support. If you are testing this feature in your SCIM app integration, contact developers@okta.com with the name of your app integration and your org ID to have Profile Sourcing temporarily activated for your org. Developer Support automatically removes the access after two weeks. If you need a longer period to test your integration, include your time requirements in your email.

Runscope tests for CRUD

If you are not familiar with Runscope, follow the detailed instructions in the Test your SCIM API topic to get started.

This suite runs the following tests:

  1. Checks that the integration exists in your Okta org.
  2. Adds a new random user in Okta.
  3. Assigns that user to the integration in Okta.
  4. Verifies that the user was created on your SCIM server.
  5. Updates the user firstName attribute in Okta.
  6. Verifies that the user attribute was updated on your SCIM server.
  7. Deactivates the user in Okta.
  8. Verifies that the user was deactivated on your SCIM server.
  9. Reactivates the user in Okta.
  10. Reassigns your integration to the user in Okta.
  11. Verifies the user was reactivated and assigned on your SCIM server.
  12. Removes your integration from the user in Okta.
  13. Verifies that user is deactivated on your SCIM server.

Configure and run tests

To configure and run the SCIM CRUD tests:

  1. Download the Okta SCIM CRUD test file.

  2. In Runscope, click Import Test.

  3. Select API Monitoring Tests as the import format.

  4. Click Choose File and select the Okta SCIM 2.0 CRUD JSON test file.

  5. Click Import API Test.

  6. In this new test bucket, click Editor from the left hand navigation menu.

  7. Click Test Settings and then click Initial Variables.

  8. Add the following variables with values that match your SCIM integration:

    • oktaAppId - the unique identifier randomly assigned to your Okta integration. You can see this value in the App Embed Link panel under the General tab for your Okta integration.

    • oktaOrgUrl - the base URL for your Okta org. Include the https:// prefix.

      Browser bar showing the oktaOrgUrl location.

    • oktaToken - the security token used to connect to your API. You can generate a token for your integration inside your Okta org:

      • Click Security > API.
      • Click Tokens and Create Token.
      • Give the token a name click Create Token.
      • Copy the resulting token value over to this Runscope variable.
    • SCIMUrl - the base URL of the SCIM implementation on your server. For example: https://example.com/scim/v2

    • SCIMAuth - the Basic or OAuth authorization token used to access your SCIM API.

    The final Runscope values should look similar to the following:

    Sample values for CRUD test variables. Runscope Initial Variables

  9. Click Test Settings and then click Initial Script.

  10. Copy the contents of the Okta CRUD Initial Script text file and paste into this Runscope console.

  11. Click Save & Run.

Review test results

On the left side of your screen, the test appears in the Recent Test Runs section.

  1. Click View Progress inside the Recent Test Runs section.
  2. As the test suite runs, Runscope displays live updates of the test in progress. After the test is complete, the main panel displays the results of your test.
  3. To see the details of tests, click the name of each particular test case to expand the section. The details show you the Request, Response, and Connection information for each test.

Run through OIN QA tests

If your SCIM integration has passed all the Runscope tests, and you are planning to publish your SCIM integration in the OIN catalog, you can now run through the OIN quality assurance test cases in this spreadsheet.

Next steps

This brings you to the end of the Build a SCIM provisioning integration series. You should now have a SCIM integration that has been successfully built and tested.

After you have completed your testing and your integration is working as expected, you can start the submission process to have your integration included in the Okta Integration Network (opens new window) (OIN).

Our Submit an app integration guide takes you through the steps required to submit your SCIM integration through the OIN Manager site.