Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

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

New display label for the test user.

username
string

New login username or email.

password
string

New password. Stored encrypted and never returned.

notes
string

New free-text hints for the agent.

login_url
string

New URL of the login page.

mfa_method
enum<string>

New second factor the account uses. none for password only.

Available options:
none,
totp,
email_otp,
magic_link
totp_secret
string

New TOTP secret. Required when mfa_method is totp. Stored encrypted and never returned.

mfa_email
string

New Strix-managed inbox for email_otp or magic_link MFA.

scope_domain_ids
string<uuid>[]

Domain ids this test user applies to. Empty array = every domain in the organization (requires unrestricted access).

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>
scope_domain_ids
string<uuid>[]

Domain ids this test user applies to. An empty array means it applies to every domain in the organization.

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>