Skip to main content
POST
auth.backend.get

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-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json

No fields. The backend is your app's own.

Response

The result

status
enum<string>
required

"ready": managed for you here. "transferred": you took it over; it still signs users in and checks tokens, and you manage it in your own account.

Available options:
ready,
transferred
authUrl
string
required

Base URL of your app's sign-in backend. Give it to your app's sign-in client.

jwksUrl
string
required

Public signing keys of the backend, for checking session tokens.

socialProviders
object[]

Social sign-in providers switched on. Only while the backend is managed here.

allowedDomains
string[]

Origins users may be sent back to after signing in. Only while managed here.