Schemas
Status
The one and only member of an error body — there is never a partial resource beside it.
SignupUser
nameThe resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
create_timeWhen the resource was created (RFC 3339, UTC).
update_timeWhen the resource last changed (RFC 3339, UTC).
etagVersion of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).
emailThe address the new account signs in with, and where the platform writes to it. Must not already be registered — users:check_email_availability says so before the form is submitted.
is_activeWhether the new account is usable. It is true on a successful signup.
account_idThe account created alongside the user — the one the new website hangs off on the Tenant API.
signup_tokenA one-time credential to trade for a bearer JWT at POST /tenant-api/v1/users:exchange_handoff, so a freshly signed-up user does not have to type the password they just chose.
operationThe name of the provisioning Operation to poll (§17). The account exists as soon as this call returns; the website is not servable until that Operation is done.
SignupUserCreate
emailThe address the new account signs in with, and where the platform writes to it. Must not already be registered — users:check_email_availability says so before the form is submitted.
passwordThe password for the new account. Write-only: it is applied and never echoed back.
website_nameWhat to call the first website. It names the account, seeds the site's own name and is the slug the platform hostname is built from. Not a field of the user, so it never comes back — read it from the website on the Tenant API.
website_typeWhich kind of site to provision, which decides the content it is seeded with. Optional; the platform picks a default.
default_languageThe language the first view is created in. It becomes the general.locale.default_language setting of the new website.
recaptcha_tokenA CAPTCHA proof, when the deployment asks for one. This is the only unauthenticated write on the platform, so it is also the only one that needs it.
request_idA client-chosen idempotency key (§15). Retrying a signup that timed out with the same value returns the first attempt's result instead of provisioning a second site.
SignupUserUpdate
emailThe address the new account signs in with, and where the platform writes to it. Must not already be registered — users:check_email_availability says so before the form is submitted.
passwordThe password for the new account. Write-only: it is applied and never echoed back.
website_nameWhat to call the first website. It names the account, seeds the site's own name and is the slug the platform hostname is built from. Not a field of the user, so it never comes back — read it from the website on the Tenant API.
website_typeWhich kind of site to provision, which decides the content it is seeded with. Optional; the platform picks a default.
default_languageThe language the first view is created in. It becomes the general.locale.default_language setting of the new website.
recaptcha_tokenA CAPTCHA proof, when the deployment asks for one. This is the only unauthenticated write on the platform, so it is also the only one that needs it.
request_idA client-chosen idempotency key (§15). Retrying a signup that timed out with the same value returns the first attempt's result instead of provisioning a second site.