foliot docs

API reference / Platform / Give a person a platform role

Give a person a platform role

POST/platform/operators

Authenticate with a signed-in Foliot Console session.

Puts a person on the platform with platform_owner or platform_operator. A signed-in person who holds a platform role (Tin Bee’s staff), read from Foliot’s own table on every request. Everyone else, an operator token and an app key included, is answered 404, the same bytes for all of them. A platform owner; a platform operator is 403. Only a VERIFIED @tinbee.com address qualifies (exactly that domain: not a subdomain, not a look-alike): 400 for any other address. The person must have signed in to Foliot once with the address on file (404 otherwise), and Clerk must say they have verified it (409 otherwise). Clerk is asked with the server’s secret key at the moment of the grant: 503 when the server has none, or Clerk does not answer, and then nothing is changed. 409 if they already hold a platform role: change it instead. Recorded in the platform’s history in the same transaction. A platform role grants nothing inside any workspace.

Request body

email
string
REQUIRED

The person's @tinbee.com address. They must have signed in to Foliot once with it, and Clerk must say they have verified it.

min length 3 · max length 320

role
"platform_owner" | "platform_operator"
REQUIRED

The platform role they are to have.

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.
404 Error No such resource.
409 Error Conflicts with existing state.
503 Error A dependency this route needs is unreachable.