How to configure SSO & SCIM for your organization?

Optery provides a self-service workflow to configure SSO & SCIM for your organization. Please follow the below steps to complete integration.

• NOTE: If your organization has not purchased SSO and/or SCIM via an Optery Sales Representative, please proceed to the Help Desk article here to complete the steps for purchase.

Step 1 - Login to your Optery for Business organization here.

• NOTE: If you have not created an Optery for Business organization, please complete the steps here first. If you need to be invited as an Administrator, please reach out to your organization's Optery for Business Administrator for access.

Step 2 - Upon logging into your Optery for Business organization, select Organization.

Step 3 - In the Organization page, select the Single Sign-On / Provision tab.

Step 4 - Email domain/s will automatically populate with the domain added by your Optery Implementation Manager when enabling SSO/SCIM on the backend or during purchase for self-serve customers.

• NOTE: Email domains can be added and updated if needed. Comma separated values are supported.

Step 5 - Update Provision Default Plan. The selected plan in this field will be assigned to new members provisioned with SSO & SCIM.

Step 6 - IF NEEDED, toggle on Disable Passwords on Invites. If toggled on, invites sent to members of your organization will not require a password to be added when creating an account.

• NOTE: This setting is not retroactive.

Step 7 - Select Generate SSO setup link and/or Generate SCIM setup link.

• NOTE: SSO & SCIM setup links are valid for 24 hours.

Below are examples of the links that will be generated when completing the above step.

Next, proceed to the below steps to begin configuration of your SSO and/or SCIM integration.

Configuring SSO/SCIM integration

Step 1 - Upon generating your organization's personalized SSO/SCIM setup links in your Optery for Business dashboard (steps above) open the link to select your Identify Provider.

Step 2 - After selecting your Identity Provider, please complete the promoted steps in the Optery Identity Provider Wizard to complete integration.

Optional Configurations for SCIM Integration

Optery can provision/de-provision users as they're imported into the application.

Provisioning

• Required: firstName, lastName, email, country
• Recommended: currentCity, currentState, birthYear

If your organization is utilizing Okta, please complete the below steps to configure your new custom plan attribute.

• NOTE: If your organization has purchased only one type of plan (Core, Extended or Ultimate) a new custom plan attribute does not need to be configured as all members will default to the Provision Default Plan setting in your Admin Dashboard.

After completing Step 3 - Set up Attribute Mapping in the Optery Identity Provider Wizard, begin adding your new custom plan attribute.

Step 1 - Within your Okta Admin Console, go to the Applications page, select Applications and then select the Provisioning tab.

Step 2 - Scroll to the middle of the page and select Go to Profile Editor

Step 3 - Select the Edit icon on any existing attribute.

Step 4 - Copy the existing External namespace and then select Cancel.

Step 5 - You will then be redirected back to the Profile Editor page. Next, select Add Attribute.

Step 6 - Create a new attribute with the below details included and select Save.

• Ensure plan is all lowercase
• Paste the copied External namespace in the previous steps to the External namespace field for the new attribute
• Set Attribute to Group
• Select Save

Step 7 - Within your Okta Admin Console, go to the Directory page and select Groups.

Step 8 - Select Add Group and create a new group for each type of plan your organization has purchased. (Ultimate, Extended and/or Core).

Step 9 - Once your Groups are created, select one of your applicable Groups.

• NOTE: The next steps must be completed for all applicable groups for your organization.

Step 10 - After selecting your newly created Group, you will then be directed to the below page. Next, select Applications.

Step 11 - Select Assign applications.

Step 12 - Select Assign to the Optery Application.

• NOTE: Your application may be named differently based on what naming convention you used when creating your new application.

Step 13 - Scroll to the bottom of the Assign Applications page to *(depending on which plan you selected) and input the applicable plan name. Then select Save and Go Back.

• For example, if you've selected the Ultimate Group, plan will require Ultimate.

Step 14 - Optery will then be Assigned to the group as seen in the screenshot below. Next, select Done.

Optery is now assigned to the applicable Group as seen below.

De-provisioning

• Downgrade Only (DEFAULT) - will downgrade a member to a Free Optery plan

NOTE: If you would like De-provisioning set as Downgrade and Remove from Organization please sync with your Optery Implementation Manager. If you are not assigned an Optery Implementation Manager, please email us at support@optery.com

NOTE: The Integration Status of SSO & SCIM is made available in the Optery for Business dashboard. Awaiting status will update to Active when configuration is completed successfully.

SSO & SCIM integration can be revoked at any time by using the above toggle option found in your Optery for Business dashboard under Organization - Single Sign-On / Provision. The below prompt will appear to provide confirmation before proceeding.

• NOTE: Deactivating Single Sign-On will also disable Directory Sync

Updated on: 18/07/2025