Skip to main content
POST
Initialize the deployment (owner + first key)

Body

application/json

The body of POST /api/setup.

setup_token is checked against the deployment's setup token. owner_user_id and key_user_id are optional — the door mints ids when they are absent. owner_display_name is required and non-empty (the principals door rejects an empty display name). login attaches the owner's interactive login when a login-attaching provider is configured; a keys-only deployment sends None.

owner_display_name
string
required
Minimum string length: 1
key_description
string
default:owner key
key_user_id
string | null
login
PasswordCredential · object

A login credential that sets the principal's password now.

owner_user_id
string | null
setup_token
string
default:""

Response

Success.

data
SetupResult · object
required

The result of a successful POST /api/setup.

api_key is the owner key's plaintext, returned exactly once. login_attached is whether an interactive login was attached; invite_token and login_path are set only when the login was an invite the operator completes later.