UUpward API
v1
POST/api/public/v1/sso
Requires x-auth-token

SSO (sign a member in)

Sign one of your people straight into their back office with a single-use login link.

How it works

  • Headers only — this request has no body.
  • Identify the member with x-auth-user (their pagename or your own external_id).
  • Send the member to the returned login_url to land them signed in on your domain (or their own connected domain).

Good to know

  • login_url works once and expires after two minutes.
  • Company owners land on the company console; everyone else on their member console.

Body fields

This endpoint takes no parameters.

Responses

200OKThe single-use login link for the member.
{
  "success": true,
  "error": "none",
  "login_url": "https://yourcompany.example.page/api/public/v1/login-link?key=…",
  "validity": "2 minutes"
}
400Bad requestThe x-auth-user header is missing.
{ "success": false, "error": "Missing x-auth-user header" }
401UnauthorizedMissing, invalid, disabled or expired key.
{ "success": false, "error": "Missing x-auth-token header" }
404Not foundNo member with that pagename or username in your company.
{ "success": false, "error": "No member found for \"john-doe\"" }
409ConflictThe member has no email address, so they cannot be signed in.
{ "success": false, "error": "This member has no email address, so they cannot be signed in." }
POST/api/public/v1/sso

Kept in this tab only — never stored, and never written into the copied code samples.

ResponseNot sent yet