Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint. Include as Authorization: Bearer <token>.

Path Parameters

domainId
string<uuid>
required

Domain id.

userId
string<uuid>
required

Test user id.

Body

application/json

Partial update. Only provided fields are changed.

label
string
username
string
password
string
notes
string
login_url
string
mfa_method
enum<string>
Available options:
none,
totp,
email_otp,
magic_link
totp_secret
string
mfa_email
string

Response

Updated test user.

A domain test account. Secrets are never returned — only boolean presence flags.

id
string<uuid>
required
label
string
required
username
string
required
mfa_method
enum<string>
required
Available options:
none,
totp,
email_otp,
magic_link
has_password
boolean
required
has_totp_secret
boolean
required
organization_id
string<uuid>
domain_id
string<uuid>
notes
string | null
mfa_email
string | null
login_url
string | null
created_by
string | null
created_at
string<date-time>
updated_at
string<date-time>