Skip to main content
POST
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.

Body

application/json
label
string
required

Display label for the test user.

username
string
required

Login username/email.

password
string

Stored encrypted. Never returned.

notes
string

Free-text hints for the agent, for example which role the account has.

login_url
string

URL of the login page where the agent signs in with this account.

mfa_method
enum<string>

Second factor the account uses. none for password only.

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

Required when mfa_method=totp. Stored encrypted.

mfa_email
string

Required for email_otp/magic_link. Must be a Strix-managed inbox in the caller's org pod (see provision-inbox).

scope_domain_ids
string<uuid>[]

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

Response

Test user created.

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>