Skip to main content
POST
auth.backend.transfer

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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

claimUrl
string
required

Link to open, signed in to your own account, to take the backend over. Whoever opens it can take the backend: keep it private. Shown once.

expiresAt
string

When the link stops working, ISO 8601, when known.