Login Ticket API

Component ID

132595

Component name

Login Ticket API

Component type

module

Maintenance status

Development status

Component security advisory coverage

not-covered

Downloads

5268

Component created

Component changed

Component body

This is a pure API module, providing functions for generating login tickets.

A login ticket consists of an automatically generated pass code, an expiration date, and a user who may log in with the pass code. This module provides functions for generating, retrieving and deleting login tickets, as well as checking validness of a given pass code and, given a valid code (while not requiring username and password), logging the concerned user in.

The Login Ticket API was designed to act as backend for modules like Temporary Invitation and Fast Login, with less (but still some) parts of the API being suitable for the Invite module as well.

Only fetch this module if another required module depends on it, or if you want to use it in order to build your own.