foliot docs

API reference / Workspaces / Make your own first workspace

Make your own first workspace

POST/me/workspaces

Authenticate with a signed-in Foliot Console session.

A signed-in person only (an operator token or an app key is 403). Makes a workspace and makes the caller its owner, for a person who has NEVER belonged to a workspace: it is the first workspace, and only that. A person who belongs to one, or has been removed from one, gets 409, and a further workspace, or one for somebody else, is the operator’s (createWorkspace). Before anything is made, a person who has been invited to a workspace is let into it (409, reload to see it), and when the identity provider cannot say whether they were invited nothing is made (503). That check is limited to one per person every few seconds (429), and it is made only after everything this server can decide for itself (a bad name, a taken slug, a person who has belonged before) has been. Who may sign in at all is the identity provider’s decision (an invite-only instance lets in only people it invited); this call adds no condition of its own. 409 as well if the slug is taken. The workspace’s history starts with who made it, the caller, and the caller is an owner at once: there is nothing to accept.

Request body

name
string
REQUIRED

What people see. 1 to 100 characters.

min length 1 · max length 100

slug
string
OPTIONAL

Lower-case letters, digits and hyphens, starting with a letter or digit; unique. Made from the name when left out.

max length 63

Responses

201 object Created
400 Error Invalid request.
401 Error Missing, malformed or unknown bearer token.
403 Error The token is valid but not permitted on this route.
409 Error Conflicts with existing state.
429 Error Too many for now: try again later.
503 Error A dependency this route needs is unreachable.