Getting started
What’s New
Roadmap
Octeth Training ProgramInstallation & Setup
Requirements
Architecture
Server Setup
Oempro InstallationCommunity Edition InstallSSL Certificates
Version Upgrade
TroubleshootingVideo Tutorials
Video TutorialsAdministration
Quick Walkthrough
Security
Sub Admin AccountsSettingsDelivery Servers
Global Segments
Global Custom Fields
Bounce Processing
Spam Complaints
Suppression List
Plug-Ins
Delivery ReportUser ManagementMaintenanceAudience Management
Introduction
Subscriber ListsCustom FieldsSegmentsSubscribers
Webhooks
Website Event TrackingEmail Marketing
Introduction
Auto RespondersEmail CampaignsSender Domain Man.
Journeys (Automation)Bounce ProcessingEmail PersonalizationFBL ProcessingEmail Builder IntegrationsEmail DeliverabilitySender Domain ManagementPlug-Ins & Add-Ons
AI Plug-InRSS Plug-InBounce Catcher Add-OnLink Proxy Add-OnDevelopers
Introduction
Single Sign On
APIPlug-In Development
DatabaseAdvanced
Reverse Proxy
CookbookHelp
Troubleshooting
Contact UsSingle Sign On (SSO)
Single sign-on is an authentication scheme that allows a user to log in with a single ID to any of several related, yet independent, software systems. True single sign-on allows the user to log in once and access services without re-entering authentication factors. (Wikipedia).
Octeth provides you a full featured SSO engine. This feature can be used to integrate Octeth with your other systems and let your users navigate between your services without re-entering authentication credentials.
Octeth supports multiple SSO sources. You can create unlimited amount of SSO sources in Octeth and use them to link multiple third party systems to your Octeth server.
Creating a SSO Source
In order to create a single sign on source, login to the admin area and go to [Admin Area → Settings → Single Sign On] section.
If this is the first time accessing this area, you will have an empty list. Click “Create SSO Source” link to create your first SSO source:
On the next screen, enter the name of the source, set a unique code to your SSO source, and fill-in other options:
| Field | Description |
|---|---|
Source Name | Give a name to your SSO source. This name is private and never displayed publicly. |
Source Code | Set a unique code for your SSO. It can be anything such as “mywebsite-test” |
Description | Optionally, you can also explain the purpose of this SSO source. |
Expires At | Optional. If you would like to expire SSO requests coming from this source, set an expire date for the SSO source. |
Valid For | Define number of seconds to keep the SSO link valid. Make sure that you keep your SSO links valid for only a few seconds to minimize the risk of link phishing. |
[_] Create New User | Once this option is checked, Octeth will create a new user account with the given information if there’s no matching user accounts in the system. |
[_] Login the user | This option will make sure that a unique session is created for the SSO user. |
[_] Return the user data | This option will force Octeth to return a JSON response with the user information and session ID instead of redirecting the user to the user area. |
Once you create your new SSO source, you will be redirected to the credentials section:
You will see an example PHP code that explains how to encrypt the user data you would like to pass in the SSO request.
The id SSO request parameter is the important parameter and it must be unique for each user you are going to pass to the SSO system. Users accounts in Octeth will be created based on these unique ID numbers.
You can create multiple SSO sources for each one of your integrations or internal systems. SSO authentication feature will give you great flexibility when moving your users from your other system to your Octeth. They will be able to switch between your systems without re-entering their login credentials.
Use Cases
Dashboard Access Button
If you would like to let users access Octeth from your other platform (dashboard, customer area, etc.), SSO is the easiest way to make it happen.
Simply create a new single sign on source in the [Admin Area → Settings → SSO] and set it just like in the screenshow shown below:
Once you have your SSO source is ready, the next step is to implement it into your other system. Whenever you want to redirect the user from your other system to Octeth, simply execute the SSO call, and then redirect user to the generated SSO link. This will make sure that user can access to his own user account in Octeth without entering username and password.
User Account Create
If you want to use SSO just for creating a user account in Octeth, simply set your SSO as shown below:
Once you execute the SSO link in your application, it will return a JSON payload including the created (or logged in) user information as well as a session ID which can be used for API calls (list create, audience import, campaign create, etc.).
