Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

Configure SCIM for Okta Guide

In this article, you’ll learn how to configure SCIM for Okta. Configuring SCIM for Okta allows you to use Okta to manage users in Wellness Coach.

After you have configured your SSO settings, you are now ready to configure SCIM for Okta. To configure SCIM for Okta, follow the steps below:

  1. Log in to your Okta portal and navigate to Applications.

  2. Click the Wellness Coach app (You must have created the Wellness Coach while configuring SSO)

  3. Select “Provisioning” and click Edit.

09a9f161-a2e8-4f03-941c-1800dfca1261
 

4. Complete all the steps mentioned below.

d5622239-b4c0-4469-ade3-cef82bbf8596

 

5. Click on “Test Connection” and verify you’re getting a successful response.

e1ec5e77-ad7f-4467-ad82-03f4d277383c

6. Now that you have set up the connection between Wellness Coach and Okta, you can enable the services that you want to manage through Okta. To get started, click To App.

7. Click Edit on the right side of the Provisioning to App section.

8. Select the Enable check box for each feature that you would like to use.

275d01a6-5368-4080-bf0e-75f0ef354b03

Attribute Mappings

In Okta, there are attribute mappings that you can customize in order to define which fields sync between Okta and Wellness Coach. To modify these attribute mappings, follow the steps below:

  1. Log in to your Okta portal and navigate to Applications.

  2. Click the SCIM application that you created in the Configuring SSO section.

  3. Click Provisioning.

  4. Click To App.

  5. Scroll down to Attribute Mappings.

  6. Make the changes that you would like to make.

  7. Save your changes.

Advanced Configuration Options for Custom attribute mapping

You can customize your Okta configuration by changing default field mappings, adding custom attributes, or mapping custom Wellness Coach fields. For more information about customizing your Okta configuration, see the subsections below.

  1. Log into your Okta admin console.

  2. Navigate to Applications and select the Wellness Coach SCIM application that you created in the Configuring SCIM section above.

  3. Click Provisioning, then under the Mappings section, click Go to Profile Editor.

  4. In the Profile Editor, click Add Mapping. An Add Attribute modal will open.

  5. Select the attribute mapping you would like to add. We offer the following additional attribute mappings in Okta, which are displayed below:

 
 

Display Name

Variable Name

External Namespace

Notes

Email

userName

Core

Required

First Name

givenName

Core

Required

Last Name

familyName

Core

Required

Employee Id

employeeNumber

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Recommended

Joining Date

joiningDate

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Recommended

Department

department

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Recommended

Country

country

Core

Recommended

Region

region

Core

Recommended

Office Location

locality

Core

Recommended

Gender

gender

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Recommended

Date of Birth

dob

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Recommended

Personal Email

secondaryEmail

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Phone Number

phoneNumbers

Core

Optional

Address

addresses

Core

Optional

Job Title

title

Core

Optional

Job Code

jobCode

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Job Level

jobLevel

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Job Family

jobFamily

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Business Unit

businessUnit

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Employment Type

employmentType

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Employee Group

employeeGroup

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Manager Name

displayName

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Manager Email

managerEmail

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Cost Center

costCenter

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Employment End Date

employmentEndDate

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Termination Reason

terminationReason

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Salary Amount

salaryAmount

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Salary Currency

salaryCurrency

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Salary Frequency

salaryFrequency

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Benefit Status

benefitStatus

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Health Insurance

healthInsurance

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Retirement Plan

retirementPlan

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Member Id

memberId

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Member Type

memberType

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Last Review Date

lastReviewDate

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Performance Rating

performanceRating

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Certifications

certifications

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Visa Status

visaStatus

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Work Authorization Expiry

workAuthorizationExpiry

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

Background Check

backgroundCheck

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Optional

 
 6. To configure your attribute mapping in the Add Attribute modal, see the screenshot and list below:

  • Data type: Select String as the Data type for your attribute mapping.

  • Display name: Enter the Display name for your attribute mapping.

  • Variable name: Enter the Variable name for your attribute mapping. This variable will be sent from Okta to the Wellness Coach provisioning app.

    Tip:Typing in the Variable name field will automatically fill in the External name field.

  • External name: Enter the Variable name for your attribute mapping. The External name field should be the same as the Variable name field.

    Tip:Typing in the Variable name field will automatically fill in the External name field.

  • External namespace: Enter the External namespace value for your attribute mapping.

    Note:The External namespace value must exactly match the value in the table. We recommend copying and pasting the value.

  • Save: Click Save to add your new attribute mapping.
704d2337-8f47-4343-a6f9-346ec3f736f3

7. Click Save Mappings to apply your changes.

8. Map your new attributes by following the Mapping Custom Fields section below.

Mapping Custom Fields

You also have the option to map custom fields to sync with Wellness Coach.

These fields are not mapped by default, but you can add them to your Okta platform by following the steps below:

NewOkta_04

NewOkta_03

  1. Log in to your Okta portal and navigate to Applications.

  2. Click the SCIM application that you created in the Configure SSO section above.

  3. Click Provisioning.

  4. Scroll down and click on Show Unmapped Attributes.

  5. Click the pencil icon next to any of the attributes that you would like to add.

  6. From the Attribute value drop-down menu, select the Okta attribute that you would like to map to each custom field.

  7. Click Save.

 

Note: If you are configuring a Custom Date attribute, the date must be formatted in ISO 8601 format. The format is as follows: YYYY-MM-DD “T” hh:mm:ssZ. For example, 2022-04-04T04:23:30Z.