<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content

Create a Test Okta SCIM Integration with the SCIM Playground

API Access Management
Okta Classic Engine
Okta Identity Engine

Overview

Developers can obtain a test System for Cross-domain Identity Management (SCIM) server and add it to an Okta organization to create and test a SCIM integration. Use the SCIM Playground to generate mock data and configure a test SCIM application in the Okta Admin Console.

 

NOTE: Only use test data with the SCIM Playground and do not export any sensitive information.

Applies To

  • Okta Identity Engine (OIE)
  • Okta Classic Engine
  • System for Cross-domain Identity Management (SCIM)

Solution

What are the steps to create a unique API key for the test?

Navigate to the SCIM Playground website to generate and store a unique API key for the test integration.

  1. Navigate to the SCIM Playground and select Get an API key.
  2. Review and accept the terms and conditions.
  3. Choose Access My Playground.

NOTE: The API key is valid for 24 hours by default. Adjust this time period to a shorter or longer value before generating the key.

  1. Store the API key from the Show API Key section in an external location for future reference.

View the generated API key in the SCIM Playground interface.

Show the API Key in SCIM Playground

Generate mock data for the test SCIM server.

Access the Data Generator in the SCIM Playground to create activated users, generate groups, and assign users to groups.

  1. Select Playground in the top-right corner, then choose Data Generator in the left-hand pane.
  2. Select the Generate Users button.
  3. Select the checkbox beside Create activated users, then choose the Generate Users button.
  4. Select the Generate Groups button.
  5. Select the Assign Users to Groups button.

Review the Data Generator options available in the SCIM Playground.

Data Generator options

What are the steps to create the SCIM application in the Okta Admin Console?

Create a new Security Assertion Markup Language (SAML) 2.0 application in the Okta Admin Console and configure the single sign-on settings.

  1. In the Okta Admin Console, navigate to Applications > Applications, then select Create App Integration.
  2. Choose SAML 2.0, then select Next.
  3. Enter a relevant value for App Name, then select Next.
  4. In the SAML Settings, enter https://scim.dev/ as the Single sign-on URL and Audience URI, then select Next.

Review the Single sign-on URL and Audience URI in the SAML Settings.

SAML Settings

Select the internal application type during the application creation process.

  1. For the App type, choose This is an internal app that we have created.

Review the internal application type selection.

App type

Enable SCIM provisioning in the application settings.

  1. Select Finish to complete the application creation.
  2. Select the General tab, then choose Edit within the App Settings section.
  3. For Provisioning, choose SCIM and select Save.

Review the App Settings with SCIM chosen for Provisioning.

App Settings with SCIM chosen for Provisioning

Configure the SCIM integration and test the application.

Configure the provisioning settings with the SCIM connector base URL and API key, then enable the provisioning options to prepare the application for testing.

  1. Navigate to the Provisioning tab, then select Edit.
  2. Enter https://api.scim.dev/scim/v2 for the SCIM connector base URL.
  3. Enter userName for the Unique identifier field for users.
  4. Select all the checkboxes beside Supported provisioning actions.
  5. Choose HTTP Header for the Authentication Mode.
  6. Paste the API key obtained from the SCIM Playground into the HTTP Header > Authorization field.
  7. Select Save.
  8. In the Provisioning to App section, select Edit, enable all options, then select Save.

Review the enabled provisioning options in the Provisioning to App settings.

Provisioning to App options enabled

Reproduce the calls from the Okta developer documentation and view the interactions in the SCIM Playground HTTP logs.

  1. Review the Okta and SCIM Version 2.0 documentation to begin testing.
  2. Navigate to Logs > HTTP Logs in the SCIM Playground to view interactions with Okta.

View the HTTP logs in the SCIM Playground to monitor interactions with Okta.

example HTTP Logs in SCIM Playground

Loading
Create a Test Okta SCIM Integration with the SCIM Playground | Okta Support