Auth API reference

Auth API · Consumer-Auth

get/{app_slug}/v1/auth/email/config

What a sign-in page needs to offer email sign-in

Public. The app's display name, whether email sign-in is on and what the email carries, and the CAPTCHA site key when bot protection is on. Says nothing about any account.

Path parameters

app_slug*string

Slug of the app.

Response · 200 The public email sign-in settings of this app.

app_name*string

The app's display name, for the page heading.

Example: "Acme"

enabled*boolean

Whether email sign-in (link or code) can be used on this app right now.

delivery*object

What the email carries; null when email sign-in is off.

ttl_minutes*number

Minutes a code or link stays valid; null when off.

Example: 10

bot_protection*object

Set when every start needs a `bot_protection_token` from this widget.

Example

Request

GET https://api.auth.productcraft.co/{app_slug}/v1/auth/email/config

Response

{
  "app_name": "Acme",
  "enabled": false,
  "delivery": {},
  "ttl_minutes": 10,
  "bot_protection": {}
}