Login pages
List, fetch, create, update and delete hosted login pages.
list_pages
List an organization’s hosted login pages. Maps to
GET /organizations/:org/pages.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
Returns the list of pages.
get_page
Fetch one login page by id. The API has no single-page GET, so this lists the
organization’s pages and returns the match. Backed by
GET /organizations/:org/pages.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
page_id | string | Yes | The page to fetch |
Returns the page, or the error no such page: <page_id>.
create_page
Create a login page. Only the name and slug are set here; edit everything else
afterwards with update_page. Maps to POST /organizations/:org/pages.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
name | string | Yes | Page name, e.g. Acme |
slug | string | Yes | e.g. acme |
Returns the created page.
update_page
Change a login page. The fields you pass are the fields that change. Branding
lives on the kit — relink with kitId. Maps to
PATCH /organizations/:org/pages/:page_id.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
page_id | string | Yes | The page to update |
name | string | No | |
slug | string | No | |
type | live, draft or unclaimed | No | |
customDomain | string or null | No | The only clearable field: null clears it |
clientId | string | No | The OAuth client the page signs in to |
kitId | string | No | The branding kit |
login_methods | object | No | password (boolean), magic_link (boolean), sso (array of provider names, e.g. ["google","ms"]) — all three |
allow_registration | boolean | No | |
whitelabel | boolean | No | |
locales | array of string | No | |
legal | object | No | privacy_policy, terms_of_service, cookie_policy, legal_notice — all four, each a URL |
Returns the updated page.
delete_page
Delete a login page. Maps to DELETE /organizations/:org/pages/:page_id.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
page_id | string | Yes | The page to delete |
Returns OK (no content).