API referenceidentity
Approve device signup
POST
/v1/signup/device:approveApprove a device-code sign-up with the e-mailed code — the agent's next poll creates the tenant
The person types the user_code, their e-mail in full and the 6-digit code e-mailed when the agent started the request.Show more
The person types the user_code, their e-mail in full and the 6-digit code e-mailed when the agent started the request. The code proves the inbox, exactly as POST /v1/signup/verify does, and lives as long as the request (15 minutes) with at most 5 wrong attempts. Once the code proves the inbox, a domain that already has a tenant is refused: 409 CONFLICT details.reason TENANT_EXISTS with nextAction request_invite, answered to the person here; the request becomes REFUSED, the agent's poll answers the same 409, and only then does that tenant's Owner receive the notification signup.tenant_exists. Otherwise the request is APPROVED; the agent's next poll of POST /v1/signup/device:token creates the tenant and receives the key, so the one-time secret is never stored at rest. No session is issued to the agent: the person, now the Owner, signs in to the console themselves (the e-mailed code, or a password they set). The event signup.device.approved and the notification of the same kind are recorded for the new tenant when the poll creates it. An e-mail other than the requested one is 400 VALIDATION details.reason EMAIL_MISMATCH and CANCELS the request (the agent's poll answers access_denied); a wrong or expired code is 400 VALIDATION details.reason CODE_INVALID. A request already approved, denied, refused, cancelled or expired is 409 CONFLICT details.reason DEVICE_SIGNUP_DECIDED; an unknown user_code is 404. Refused at boot above SANDBOX. Address limits: IdentityRateLimited, details.action signup-device-approve. MCP: excluded.Request body
- userCodestringRequired
- emailstring · emailRequired
- codestringRequired
Responses
- 200Approved; the agent's next poll creates the tenant and receives its sandbox keyDeviceSignupDecision
- 400VALIDATION — EMAIL_MISMATCH (another e-mail; the request is cancelled), CODE_INVALID (a wrong or expired code), or details.field naming a malformed memberApiErrorResponse
- 404NOT_FOUND — unknown or expired ref (unguessable refs, 15)ApiErrorResponse
- 405ApiErrorResponse
VALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge).Show more
VALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge). Not retryable as sent. - 409CONFLICT — DEVICE_SIGNUP_DECIDED (the request was already approved, denied, refused, cancelled or expired), or TENANT_EXISTSApiErrorResponse
- 413ApiErrorResponse
VALIDATION — the request body is larger than the surface's limit.Show more
VALIDATION — the request body is larger than the surface's limit. Not retryable as sent: shrink the body. Declared on every operation that takes a request body. details carries exactly one key, maxBodyBytes (integer): the limit that applies to this surface, in bytes. - 414ApiErrorResponse
VALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge).Show more
VALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge). Not retryable as sent: send long input in the body of a POST. - 415ApiErrorResponse
VALIDATION — a request body that is not JSON (application/json or application/*+json; a form body only on the OAuth token routes).Show more
VALIDATION — a request body that is not JSON (application/json or application/*+json; a form body only on the OAuth token routes). The public edge refuses it before the platform sees it (details.reason UNSUPPORTED_MEDIA_TYPE, details.source edge). Not retryable as sent: send Content-Type application/json. Declared on every operation that takes a JSON request body. - 429ApiErrorResponse
Counted in fixed windows (default 15 min).Show more
Counted in fixed windows (default 15 min). The signup, login, password and invite routes count every attempt per client address AND per subject (the email, the username + site, or the invite token). POST /v1/oauth/token is counted three ways, none of them on client_id alone, so knowing a client_id (which is not secret) never lets anyone spend its holder's budget: oauth-token counts every attempt per client address only; oauth-token-failure counts FAILED client authentications per client address and per (client address, client_id) pair; oauth-token-issued counts tokens issued per client_id only, and only a request whose secret, grant_type and scope all passed can spend it. details.reason says which limit tripped (CLIENT_RATE_LIMITED | SUBJECT_RATE_LIMITED) and details.action which count (signup | signup-verify | login | password-forgot | password-reset | invite-accept | oauth-token | oauth-token-failure | oauth-token-issued). Retry-After is whole seconds to the end of the window, and details.retryAfterMs mirrors it. The answer is the same whether or not the account or key exists, so the limit cannot be used to enumerate accounts, and nothing the caller sent is echoed. adds three counts per client address for the MCP grant routes: oauth-authorize (GET /v1/oauth/authorize, which may fetch a Client ID Metadata Document), oauth-register (POST /v1/oauth/register) and oauth-device (POST /v1/oauth/device_authorization), and one count per MCP grant, oauth-exchange-grant (the token exchange of POST /v1/oauth/token, counted per grant after the exchange client and the subject token verified, default 120 a minute), whose details.reason is EXCHANGE_RATE_LIMITED. - 500INTERNAL — a bug, and traceId is the support handle.ApiErrorResponse
- 501NOT_IMPLEMENTED DEVICE_SIGNUP_UNAVAILABLE — device-code sign-up is off on this deploymentApiErrorResponse
Errors you should handle
Branch on code and honour retryable — never on the HTTP status alone.
| 400 | VALIDATION This sign-up was requested for another e-mail address and has been cancelled. | not retryable |
| 404 | NOT_FOUND searchRef SR-F-7b31d0a9 is unknown or has expired; re-search | not retryable |
| 405 | VALIDATION This method is not served. | not retryable |
| 409 | CONFLICT This sign-up request has already been decided. | not retryable |
| 413 | VALIDATION The request body is larger than this API accepts (262144 bytes). | not retryable |
| 414 | VALIDATION The request URI is longer than 8 KiB. | not retryable |
| 415 | VALIDATION Send application/json. | not retryable |
| 429 | RATE_LIMITED Too many requests of this kind for this address or account. Wait for the Retry-After interval before trying again. | retryable |
| 500 | INTERNAL An unexpected error occurred. Quote the traceId to support. | retryable |
| 501 | NOT_IMPLEMENTED Device-code sign-up is not available on this deployment. | not retryable |