UserLoginTokens
Introduction
UserLoginTokens are short-lived, one-time credentials that let a browser sign in a User without entering that user's password. See User Login Token for the browser login flow.
The signed token is returned only when the record is created. Store or forward it securely because list and show responses cannot retrieve it later.
Model Definition
Relations
Tokens use UUIDs, expire at expires_at, and are soft-deleted after use or explicit deletion.
Admin: List
List all UserLoginTokens in administration scope.
Definition
GET /api/administration/users/login-tokens
Request Keys
selects
string
All fields except the internal ID
Comma-separated fields to return.
relations
string
Default relations
Pipe-separated relations to include.
limit
integer
No limit
Maximum number of records.
Behavior
The administration list includes soft-deleted tokens. The secret token is never returned.
Example Request
Example Response
Admin: Show
Show one UserLoginToken in administration scope.
Definition
GET /api/administration/users/login-tokens/{userLoginToken}
Route Parameters
userLoginToken
UUID
UserLoginToken UUID.
Request Keys
selects
string
All fields except the internal ID
Comma-separated fields to return.
relations
string
Default relations
Pipe-separated relations to include.
Example Request
Example Response
Admin: Create by User ID
Create a UserLoginToken for one user ID.
Definition
POST /api/administration/users/login-tokens
Request Keys
expires_in*
integer
-
Lifetime in seconds, from 1 through 86400.
Keys with * are required.
Behavior
user_id is always taken from the authenticated user and cannot be overridden. The example's 300-second lifetime produces the shown expires_at value from the creation time.
Example Request
Example Response
Admin: Create by Email
Create a UserLoginToken for one email address.
Definition
POST /api/administration/users/login-tokens/email
Request Keys
expires_in*
integer
-
Lifetime in seconds, from 1 through 86400.
Keys with * are required.
Behavior
user_id is always taken from the authenticated user. The email is resolved to login_user_id; therefore the example request contains the value needed to produce login_user_id: 19 in the response.
Example Request
Example Response
Admin: Delete
Delete an existing UserLoginToken.
Definition
DELETE /api/administration/users/login-tokens/{userLoginToken}
Route Parameters
userLoginToken
UUID
UserLoginToken UUID.
Example Request
Example Response
Last updated