External User Connector – REST

External User Connector – REST

Authenticate your users against an external system, such as a web service or enterprise identity provider. When external auth is configured, user passwords are never stored on our platform.

Azure AD is being renamed to Microsoft Entra ID.

When logged into the web portal, navigate to Organization & Users > Organization Setup > Integrations > External User Authentication And Provisioning, and the following options will be available:

Okta, Azure AD (Entra ID), and Ping Identity require Enterprise ToolKit.

REST

When a user logs in on our website or apps, our system will receive the login request and ensure the user’s email is registered on our platform.

Assuming the user email is found, our system will then transparently ‘pass through’ the login credentials to this external web service URL for authentication.

The external service MUST return a 200 HTTP status code to be considered authenticated by our platform; any other response will be deemed a login failure.

Authentication URL

When a user logs in on our website or apps, our system will receive the login request and ensure the user email is registered on our platform.

Assuming the user email is found, our system will then transparently ‘pass through’ the login credentials to this external web service URL for authentication.
The external service MUST return a 200 HTTP status code to be considered authenticated by our platform; any other response will be deemed a login failure.

The following placeholders can be used to inject user’s identifier, login, organization ID and device operating system, name and IP address into the URL, headers and body:

{{USERID}}
{{USEREMAIL}}
{{USERPASSWORD}}
{{USEREXTERNALID}}
{{ORGID}}
{{DEVICEOS}}
{{DEVICENAME}}
{{DEVICEIP}}

HTTP Action

Select the request action (POST, PUT, GET) and Data As (JSON, URL Encoded, XML).

Data as

Specify the REST API format

  • JSON
  • URL Encoded
  • XML

HTTP Auth Type

If your service uses HTTP Basic authentication, then you do not need to configure Headers or specify any placeholders in the Destination URL. Our system will automatically add the required headers and will encode the user’s email and password onto the given URL.

Find out more about Basic Auth

Forgot Password URL

Login processes on our platform provide a ‘Forgot Password’ option for users to request a password reset via email.

Our system will forward these password reset requests to the given external service URL as a HTTP GET action.
The external service MUST return a 200 HTTP status code to be considered successful by our platform; any other response will be deemed a failure.

The following placeholders can be used to inject the user’s identifier, email, organization ID, device operating system, name, and IP address into the URL:

{{USERID}}
{{USEREMAIL}}
{{USEREXTERNALID}}
{{ORGID}}
{{DEVICEOS}}
{{DEVICENAME}}
{{DEVICEIP}}

Okta

Please refer to Provisioning Users and Single Sign-On with Okta

Azure Active Directory

Please refer to Provisioning Users and Single Sign-On with Azure Active Directory.

Ping Identity

Please refer to Single Sign-On with Ping Identity. 

    • Related Articles

    • Form Connector – REST

      This Connector will be interesting if you have access to technical personnel (software developers) and want to tightly integrate with our platform. The REST Connector will automatically send form entry data in XML or JSON format to your specific web ...

    • REST Field

      The REST field type enables you to issue a REST request in JSON or XML to an external web service and pull data from any API. The result of the request is stored in the REST field, and you can then access the result’s values through our existing ...

    • Form Connector – REST 2-Step Scenario

      It’s common to encounter a scenario where you wish to interface with one API endpoint and then use the response as input data for another API interaction. To achieve this, our REST Field and REST Form Connectors support up to two steps in REST API ...

    • Connecting to REST with OAuth 2.0

      OAuth 2.0 is an authorization protocol that allows applications to access user data from other services without sharing the user’s credentials. It enables users to securely grant limited access to their resources on one service to another ...

    • Syncing Data with External Systems

      Step 1: Define and Connect a Data Source To display and manipulate data rows from an external system, you will first need to define a Data Source that models the particular data entity in question. Effectively, a Data Source is just rows and columns ...