Chelabase
ManagementApp users

Enable app users, or change their settings

PUT
/v1/projects/{id}/app-users

With no settings yet this enables app users: it checks the database, the data API on every branch and the table, then answers 202 and the worker creates the project's identity pool, the users table and its guard. Pressing it again while enabling, or after failed (same location), starts the work again (202), and so does pressing it on a disable on hold (disabling with an error: its pool still has users), which keeps the pool and its users. Once enabled it changes email_verification and on_delete only (200); another location is 409 app_users_location_fixed.

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Project id

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

database_id*DatabaseId

The Chelabase database (of this project) that holds the users table.

Formatuuid
email_verification?|

Default false.

on_delete?|

What deleting a user does to its row: delete (default) or mark.

pg_database?|

Defaults to the database's main Postgres database. Fixed once app users are enabled.

schema?|

^[a-z_][a-z0-9_]{0,62}$, default public; not a reserved schema. Fixed once enabled.

table?|

^[a-z_][a-z0-9_]{0,62}$, default users. Fixed once enabled.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/app-users" \  -H "Content-Type: application/json" \  -d '{    "database_id": "91088904-0b92-46ad-9240-e1afa0da22df"  }'
{  "database_id": "91088904-0b92-46ad-9240-e1afa0da22df",  "email_verification": true,  "error": "string",  "on_delete": "delete",  "pg_database": "string",  "schema": "string",  "status": "enabling",  "table": "string"}

Disable app users DELETE

Refused while the project's pool has any user. Otherwise 202: the worker removes the guard machinery (the table stays as an ordinary table), drops the pool and deletes the settings. Pressing it again while `disabling` starts the work again.

List a project's users GET

50 per page. `search` matches part of the email, ignoring case.