| Call | Answer |
|---|---|
POST /v1/auth/signup {email, password, name?} | 201 {user, team}, and sets the session cookie. The password needs at least 10 characters. It emails a link that verifies the address: until the owner opens it, team.verified is false and creating a sandbox, task or key answers 403 email-unverified |
POST /v1/auth/verify {token} | {user}, verified. The token is the #token= of the emailed link; it works once, for 24 hours |
POST /v1/auth/resend-verification | {sentTo}: a new link, at most 3 an hour |
POST /v1/auth/login {email, password} | {user, team}, and sets the cookie |
POST /v1/auth/forgot-password {email} | {sentTo}, whether or not the address has an account. If it has one, a reset link is mailed; it works once, for 1 hour |
POST /v1/auth/reset-password {token, password} | {user, team, endedSessions, revokedKeys}, and sets the cookie. The password changes, the email counts as verified, every other session of the user ends, and every personal key they made, on every team, is revoked. endedSessions and revokedKeys say how many went. Service keys stay |
POST /v1/auth/logout | 204 |
GET /v1/me | {user, team, role, teams: [{id, name, role, kind}]} |
POST /v1/me/team {teamId} | Switches the session to another of the user’s teams |
GET /v1/team (key or session) | {id, name, slug, createdAt, limits: {maxSandboxTimeoutMs, maxTaskTimeoutMs}} |
PATCH /v1/team {name} | The team (owners only) |
POST /v1/teams {name, region?} | 201 team: a new organization you own (region is us, the only one for now). Switch to it with POST /v1/me/team. A personal account (kind: personal) is one person and cannot invite; an organization gets no additional signup credit, so its work requires granted or purchased credit. Payments are currently disabled: contact hello@offstage.cloud |
GET /v1/team/members | {members: [{userId, email, name, role, addedAt}], invites: [{email, invitedAt, invitedBy, expiresAt, status}]} |
POST /v1/team/members {email} | 201 {member, emailed} for an existing user whose email is verified, or 201 {invite, emailed} otherwise, which joins only once the address is proven (the verification link opened, a password reset, or a GitHub or Google sign-in), within 7 days; sending it again renews it (owners of an organization only; 403 personal-team on a personal account) |
PATCH /v1/team/members/:userId {role} | the member with its new role, owner or member (owners only). The last owner cannot step down |
DELETE /v1/team/members/:userId | 204. Anyone may leave, and owners may remove others. The last owner cannot be removed. The personal keys the member made on this team are revoked; service keys stay |
DELETE /v1/team/invites/:email | 204: the invite is withdrawn, and that address does not join when it is proven (owners only). 404 not-found when there is no pending invite |
Account and billing
Team and account
Sign-in, members, invites and organizations.
These are console calls, made with the session cookie.