LoginRadius API Documentation

Developers, we have compiled these comprehensive guides and documentation to help you work with the LoginRadius API in ways that will meet your company’s requirements as quickly and efficiently as possible. On this page, you will find essential documentation on getting started, process flows and comprehensive guides for implementing various platform features, our SDK libraries and much more!

Get Started

Desk.com Single Sign On Authentication

Desk.com uses multipass authentication for user authentication and allows single sign on between your website and desk.com support portal.

In order to authenticate users on your desk.com support portal, you have to pass multipass (encoded data)which is generated with user’s information.

Process for generating multipass and providing SSO

  1. First of all you need to build user data using the following attributes that contains user information at your system.
Key
Required
Value

uid

Yes

Unique string of the user. This is the unique identifier of the user in your system, such as their guid or auto incremented id.

expires

Yes

Multipass expiration date in ISO 8601 format. This is for security purposes to expire the hash after a given period of time.

to

No

Absolute URL to redirect the user after successful login. If this is not supplied, users are either redirected to the original page they were viewing/attempting to view on your portal, or they are redirected to your portal's home.

customer_email

Yes

Customer's email address

customer_name

Yes

Customer's name

customer_custom_key

No

The custom customer field identified by key

Example of user information:

$user_data = array(

'uid' => '123abc',

'customer_email' => 'testuser@yoursite.com',

'customer_name' => 'Test User',

'expires' => date("c", strtotime("+5 minutes"))

);
  1. After that, generate multipass token using PHP SSO SDK from desk.com
    https://github.com/assistly/multipass-examples/blob/master/php.php

In order to get multipass and signature, you need to pass in the user data (user data obtained in step 1), subdomain variable (which is provided by desk.com) and API_key (which is provided by desk.com) into the above PHP SDK.

Desks PHP SDK (mentioned above) will generate a multipass as well as signature. Multipass contains user data in the ​encoded format which is secured. Signature is required to ensure that the received multipass is indeed coming from you (basically from your master system) and data is not tampered with.

  1. At Last, append the generated multipass and signature to the following desk.com URL query parameters which will perform the Single Sign on with Desk.com and redirect the user to this URL.
    http://yoursite.desk.com/customer/authentication/multipass/callback?multipass=**MULTIPASS**&signature=**SIGNATURE**

MULTIPASS: Add multipass generated in step 2

SIGNATURE: Add signature generated in steps 2.

For more details about Desk.com multipass SSO visit: http://dev.desk.com/guides/sso/

Desk.com Single Sign On Authentication

Desk.com uses multipass authentication for user authentication and allows single sign on between your website and desk.com support portal.