What is Single Sign On?

Single sign on allows our users to log in to other systems using TutorCruncher. An example of this would be signing into other applications using your Google or Facebook credentials.

In our case, you can set a link from TutorCruncher to another system accessible from the menu, which passes arguments to the other system containing the user's information. A working example of this is available at the link below.

Click here to see an example of TutorCruncher's SSO.

How do I set up SSO in TutorCruncher?

Before you start you will need to make sure the system you want to allow SSO with works with TutorCruncher.

Go to System > Settings > TutorCruncher API > SSO Configuration, and click 'Add SSO Config'. On the next form you have a set of fields that must be filled in:

Field	Description
Name	The name of the system you wish to allow SSO to.
Permitted Roles	The roles you want to be allowed to access the system. In this case, contractor = tutor and servicerecipient = student.
URL	The address users sign in from TutorCruncher with. You will need to check with the system provider for this.
Key	Unless you have been told otherwise, leave this blank and TutorCruncher will generate one for you.
Launch Icon	You can use any of the icons from here.
Launch from menu	Whether your users can access the link from the main menu.
Menu display name	The name you want to display to your users.
Launch from Lesson	Whether your users can access the link from a lesson.
Lessons display name	The name you want to display to your users.

Token Variables

TutorCruncher supplies the following variables in SSO tokens:

Key	Description
`id`	ID of the User, unique for each User
`nm`	First and last name of the User
`rt`	Role type, Administrator, Client, Contractor (Tutor) or ServiceRecipient (Student)
`role_id`	ID for the Role, unique for each Role
`e`	Email address of the User
`ts`	Unix timestamp when the user clicked the link, aka "now"
`tz`	The user's timezone name, this maybe null if no User or Branch timezone is configured *
`br_id`	Branch ID, the ID of the branch the user clicked the link from, generally there's one Branch per company but there can be more
`br_nm`	Branch name
`apt_id`	Appointment (Lesson) ID, unique for each Appointment (only available when the SSO link was followed from an Appointment)
`apt_nm`	Name or topic of the Appointment (only available when the SSO link was followed from an Appointment)
`apt_st`	Unix timestamp for the start datetime of the Appointment (only available when the SSO link was followed from an Appointment)
`apt_fn`	Unix timestamp for the finish datetime of the Appointment (only available when the SSO link was followed from an Appointment)
`sr_nms`	List of all the ServiceRecipient (Student) names that have been added to the Appointment (Lesson)
`con_nms`	List of all the Contractor (Tutor) names that have been added to the Appointment (Lesson)
`srs`	List of all the ServiceRecipient (Student) IDs that have been added to the Appointment (Lesson)
`cons`	List of all the Contractor (Tutor) IDs that have been added to the Appointment (Lesson)
`srv_id`	ID of the service, unique for each service (Job)

* Timezones are provided as ISO timezone names eg. America/New_York, see the "YZ" column here.

If you have any questions regarding SSO, contact support@tutorcruncher.com, or there is more information regarding how to use SSO available at our example here.

TutorCruncher Website Integration Guide