Skip to main content

OKTA SCIM

Add OKTA SCIM protocol to your existing OKTA SSO setup.

Holly Bryski avatar
Written by Holly Bryski
Updated over 5 months ago

1. Add SCIM provisioning in OKTA

  • After your SSO integration is created, click the General tab.

  • Click Edit within the App Settings group.

  • In the Provisioning section, select Enable SCIM provisioning and click Save.

2. Update provisioning options

  • Select the new Provisioning tab. The SCIM connection settings appear under Settings > Integration.

  • Click Edit.

  • Enter the following information to set up

    • SCIM connector base URL:
      https://api.airmason.com/api/v1/scim/v2

    • Unique identifier field for users:
      userName

    • Supported provisioning actions:
      Check all of the following:

      • Import New Users and Profile Updates

      • Push New Users

      • Push Profile Updates

      • Push Groups

    • Authentication method:
      HTTP Header

    • Token:
      AirMason will provide you with your unique API key. If you haven’t received one, please contact the integrations team.

Note: When selecting your “Supported provisioning actions”, you may choose to select “Import Groups” to experience the full provisioning functionality. If you check this box, you may find that you encounter a 400 Bad Request error upon saving your configuration. If that is the case, you’ll need to open a support ticket with Okta to request that the SELECTIVE_APP_IMPORT_PLATFORM feature is enabled.

3. Update user mappings

To ensure accurate synchronization between Okta and AirMason, you'll need to map specific user attributes. Some of these attributes may not exist by default in Okta and will require manual creation. Once established, these attributes can be mapped to AirMason's SCIM fields.

Attribute Name

Field in AirMason

Description

office

location

User's office location

organization

company

Organization name

department

department

Department within the company

division

division

Division within the department

code

code

Custom code (e.g., employee code)

state

state

State or province

employeeType

employeeType

Type of employment (e.g., full-time, contractor)

country

country

Country of residence

name

name

Full name (combination of givenName and familyName)

email

email

Email address

source

source

Employee number or identifier

Part A: Creating Custom Attributes in Okta (If Needed)

For attributes like office, organization, department, division, code, state, and employeeType, you may need to create custom attributes in Okta if they do not exist. Here's how:

  1. Access the Profile Editor:

    • In your Okta Admin Console, go to the Provisioning tab of your AirMason application.

    • Under Settings in the left panel, select To App.

    • Click on the Go To Profile Editor button.

  2. Add a New Attribute:

    • Click Add Attribute.

    • Fill in the necessary details:

      • Display Name: e.g., Office

      • Variable Name: e.g., office

      • External Name: Same as variable name

      • External Namespace: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

      • Data Type: string

      • Description: Optional, but helpful for clarity.

    • Click Save or Save and Add Another.

Repeat this process for each custom attribute you may need. For more detailed instructions, refer to Okta's support article on Creating a New Custom Attribute.

Part B: Mapping Okta Attributes to AirMason SCIM Fields

Once the above is completed,

  • Click on the Mappings button.

  • On the popup, select the Okta User to AirMason Tab.

  • Use the following table as a reference:

Okta Attribute

AirMason User Profile

user.country

country (should exist already)

user.firstName

givenName (should exist already)

user.lastName

familyName (should exist already)

user.email

email (should exist already)

user.employeeNumber

employeeNumber (should exist already)

user.organization

organization (should exist already)

user.department

department (should exist already)

user.division

division (should exist already)

user.office

office

user.code

code

user.state

state

user.employeeType

employeeType

Note: Custom attributes need to be created in Okta before they can be mapped. Some standard attributes are available by default.

  • After mapping all necessary attributes, click Save Mappings.

  • Confirm the changes when prompted.

For more information on attribute mapping, see Okta's guide on Mapping Attributes from Okta to an Application.

These fields are utilized within AirMason for personalization, access control, and organizational structuring.

Did this answer your question?