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

  • Authenticate with x-auth-token and identify the member with x-auth-user (their pagename or your own external_id).
  • The body is optional. Send it only to open a specific page (see redirect below); with no body the member lands on their default home page.
  • 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.

Optional: send the member to a specific page (redirect)

  • Send a JSON body (Content-Type: application/json) with a redirect field. After a successful sign-in the member lands on that page instead of the default home page. Leave it out to keep the default.
  • Write the page the way it appears **after** /member-admin/. Do not include the domain, https://, or /member-admin itself. Example: to open /member-admin/crm/sms-center, send { "redirect": "crm/sms-center" }.
  • Company owners are signed in to the company console, so the same value opens /company-admin/crm/sms-center for them. You do not need to tell them apart.
  • A few harmless variations are tidied for you: /crm/sms-center, crm/sms-center/, crm//sms-center and member-admin/crm/sms-center all work the same as crm/sms-center.
  • A query string is allowed, for example "crm?tab=leads". # fragments, full URLs, .., spaces and backslashes are refused with a 400 that says what to fix. Maximum 300 characters.
  • The page is not checked against a list: a path that does not exist shows the app's "page not found" inside the console, still signed in. Test each hotlink once.
  • The member still needs access to the page. If their plan or permissions do not include it, they see the normal locked or no-access screen there.
  • Only the JSON body is read: a redirect in the URL or in a header is ignored.

Examples

  • No body → default home page.
  • { "redirect": "crm/sms-center" } → /member-admin/crm/sms-center.
  • { "redirect": "meetings" } → /member-admin/meetings.

Body fields

redirectstring (≤300)optional

Page to open after sign-in, written as it appears after /member-admin/ (for example crm/sms-center). Leave out for the default home page.

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, the body is not valid JSON, or the optional redirect is not a valid page path (the error says what to fix).
{ "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

Page to open after sign-in, written as it appears after /member-admin/ (for example crm/sms-center). Leave out for the default home page.

ResponseNot sent yet