REST External User Authentication Connector

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}}

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.

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 an 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 and device operating system, name and IP address into the URL:

{{USERID}}

{{USEREMAIL}}

{{USEREXTERNALID}}

{{ORGID}}

{{DEVICEOS}}

{{DEVICENAME}}

{{DEVICEIP}}