Skip to main content
POST
auth.enterprise.start

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
connectionRef
string
required

The connection to sign in through.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
redirectUri
string
required

Where sign-in returns to. Must be exactly one of the connection's redirect addresses.

Maximum string length: 512
state
string
required

A fresh random value your app keeps in the visitor's session, compares on return and sends as state to auth.social.exchange.

Required string length: 22 - 512
Pattern: ^[A-Za-z0-9._~-]+$
nonce
string
required

A fresh random value your app keeps in the visitor's session and sends as expectedNonce to auth.social.exchange.

Required string length: 22 - 512
Pattern: ^[A-Za-z0-9._~-]+$
codeChallenge
string
required

The S256 challenge: base64url of the SHA-256 of the code verifier your app keeps in the visitor's session.

Pattern: ^[A-Za-z0-9_-]{43}$

Response

The result

authorizationUrl
string
required

Send the visitor here to sign in. A link on our host; it opens once.

expiresAt
string
required

When the link stops working, ISO 8601.