Skip to main content
POST
Get a sign-in handoff for a storefront page

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session JWTs, and portal JWTs the server minted read-only, are refused with 403 on every write.

Body

application/json

What a storefront sign-in handoff request carries.

continuity
string
required

A random secret the app generates for this handoff and keeps. Only its digest is stored; the app sends it again in the redeem's body. Treat it as a secret.

Required string length: 32 - 128
return_path
string
default:/

The page of the storefront to land on, a path on the company's storefront host that starts with a single /. The handoff's site_url is the storefront URL of this path.

Maximum string length: 2048
Pattern: ^/(?![/\\])[^\x00-\x1f\x7f]*$

Response

The handoff.

The sign-in handoff for a site.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

A single-use handoff that signs the member in on their company's storefront.

meta
object
required

Envelope metadata present on every response.