SynqDocs
Management APIBrands

Read a brand's sign-in page

Where each way to sign in goes (shown first, under More ways, or off, and for whom), what follows the email address, and what people coming back see. Needs `org.brands.view`.

GET/v1/orgs/{org}/brands/{brand}/sign-in-page

Where each way to sign in goes (shown first, under More ways, or off, and for whom), what follows the email address, and what people coming back see. Needs org.brands.view.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

The org's id

Match^org_[0-9a-hjkmnp-tv-z]{26}$
brand*string

The brand's id

Match^brd_[0-9a-hjkmnp-tv-z]{26}$

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/brands/brd_01h455vb4pex5vsknk084sn02q/sign-in-page" \  -H "Authorization: Bearer $SYNQ_API_KEY"
{  "methods": [    {      "method": "google",      "name": "Google",      "kind": "provider",      "placement": "shown",      "off_for": null,      "available": true,      "link_only": false,      "community_links": false,      "icon_url": null    }  ],  "max_shown": 4,  "email": {    "password": true,    "code": true,    "lead": "password"  },  "returning": "last_only"}