Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange.

Headers

X-Organization-Id
string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing. Absent, the session's default organization answers.

Path Parameters

id
string<uuid>
required

The environment's id.

Body

application/json

Any subset of the fields. A waitlist may only be held where UserKit owns the sign-in.

auth_mode
enum<string>
Available options:
hosted,
federated
waitlist_mode
boolean

Hold a line instead of opening the door: sign-ups join the queue, and no session is minted for anybody still in it — by any route, social included.

disposable_email_policy
enum<string>

Refuse sign-ups from throwaway inbox services. allow by default: a disposable address is somebody who does not trust the product yet, not a fraud signal, and blocking costs you that sign-up — the trade is yours to make.

Available options:
allow,
block
require_captcha
boolean

Demand a solved captcha on the public sign-up doors of this environment. Inert while the server reports captcha_available: false.

Response

Updated.

environment
object