Chatroll Single Sign-On (SSO) API

Chatroll’s Single Sign-On (SSO) API enables integration of the Chatroll module with your existing website or app’s user profile system.

By integrating with Chatroll’s SSO API, you can:

  1. Have users who log in to your website or app authenticate automatically with Chatroll.
  2. Use your website or app’s own user profile system. Usernames, profile page links and avatars are displayed in the chat.
  3. Limit access to the chat to authenticated users only. This can be an effective security precaution, since users will only be able to access the chat after signing into your system.

How to Enable SSO

Follow these steps to enable Chatroll SSO within your website or app:

  1. Go to your chat Dashboard and click Embed Code.
  2. Chatroll provides several pre-packaged SSO plugins. If you see your website or app platform listed, click the appropriate icon.
  3. If your website or app platform is not listed, click the Custom Application icon.
  4. Follow the instructions provided.

For more information about the SSO API, please see below.


SSO API and Parameters

The SSO API parameters are passed to Chatroll as HTTP GET parameters, by appending them to the Chatroll iframe embed URL.

Sample iframe embed HTML with SSO API parameters



Parameter Specifications

Parameter Description and Usage Valid Values Required/ Optional
uid Unique User ID of signed-in user. Provided by you. Alphanumeric string, dash (-) and underscore (_).

Limited to 64 characters.

Set uid to 0 to sign out the user.

uname Username that is displayed. URL encoded UTF-8 string.

Limited to 64 characters long.

upic Publicly accessible URL path to the user’s profile picture. A default image will be displayed if this value is not specified. URL encoded path to a .JPG, .PNG or .GIF picture.

Limited to 1024 characters.

ulink URL link to the user’s profile page. If specified, the username and profile picture will be linked to this URL. URL encoded path.

Limited to 1024 characters.

ismod Specifies whether the user has moderation privilege. Moderators can delete all posted messages and ban unwanted users. 1 or 0.

1 = has moderation privilege

0 = no moderation privilege

sig Authentication signature for request validation. All Profile API parameters will be ignored if this value is invalid or missing. MD5 hash of the concatenated string: uid + uname + ismod + secretkey Required

PHP Code Sample for Chatroll SSO Integration



Related Articles