Verify a test user's login

POST

networks

{networkId}

test-users

{userId}

verify

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "test_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "failure_code": "invalid_credentials",
  "detail": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "evidence": [
    {
      "success": true,
      "failure_code": "<string>",
      "account_index": 123,
      "captured_at": "2023-11-07T05:31:56Z",
      "artifacts": {
        "recording": {
          "content_type": "<string>",
          "bytes": 123
        },
        "screenshot": {
          "content_type": "<string>",
          "bytes": 123
        },
        "response": {
          "content_type": "<string>",
          "bytes": 123
        }
      }
    }
  ]
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "test_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "failure_code": "invalid_credentials",
  "detail": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "evidence": [
    {
      "success": true,
      "failure_code": "<string>",
      "account_index": 123,
      "captured_at": "2023-11-07T05:31:56Z",
      "artifacts": {
        "recording": {
          "content_type": "<string>",
          "bytes": 123
        },
        "screenshot": {
          "content_type": "<string>",
          "bytes": 123
        },
        "response": {
          "content_type": "<string>",
          "bytes": 123
        }
      }
    }
  ]
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

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.

Scopes

test_users:write

Path Parameters

networkId

string

required

A network connector id, or direct for this install (self-hosted only).

userId

string<uuid>

required

Test user id.

Query Parameters

force

enum<string>

Set to 1 to re-verify even when a recent result exists (use after changing the credentials or headers).

Available options:

1

Body

application/json

headers

object[]

Custom HTTP headers the scan will send, for example a bot-protection bypass header. The verification sends them on requests to the login URL's origin, so the check reaches the login page the same way the scan will. Values are stored encrypted and never returned. Rows with a blank name or value are ignored.

Maximum array length: 10

Show child attributes

Response

An in-flight or recent verification was reused.

Outcome of a pre-scan login verification run for a saved test user.

string<uuid>

required

domain_id

string<uuid>

required

The domain the check ran against. Use it as domainId when you download evidence.

status

enum<string>

required

Available options:

pending,

running,

succeeded,

failed

created_at

string<date-time>

required

test_user_id

string<uuid> | null

failure_code

enum<string> | null

Category of the failure when status is failed.

Available options:

invalid_credentials,

login_page_not_found,

mfa_required_not_configured,

mfa_code_unavailable,

account_locked,

target_unreachable,

bot_protection,

launch_failed,

other,

null

detail

string | null

Human-readable explanation of the outcome. Never contains credentials or email contents.

started_at

string<date-time> | null

finished_at

string<date-time> | null

evidence

object[] | null

Evidence of the login attempt, when the agent recorded one. Download one artifact with GET /domains/{domainId}/login-evidence/{checkId}/{attempt}/{kind}, where checkId is this check's id and attempt is the index in this list.

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "test_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "failure_code": "invalid_credentials",
  "detail": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "evidence": [
    {
      "success": true,
      "failure_code": "<string>",
      "account_index": 123,
      "captured_at": "2023-11-07T05:31:56Z",
      "artifacts": {
        "recording": {
          "content_type": "<string>",
          "bytes": 123
        },
        "screenshot": {
          "content_type": "<string>",
          "bytes": 123
        },
        "response": {
          "content_type": "<string>",
          "bytes": 123
        }
      }
    }
  ]
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "test_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "failure_code": "invalid_credentials",
  "detail": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "evidence": [
    {
      "success": true,
      "failure_code": "<string>",
      "account_index": 123,
      "captured_at": "2023-11-07T05:31:56Z",
      "artifacts": {
        "recording": {
          "content_type": "<string>",
          "bytes": 123
        },
        "screenshot": {
          "content_type": "<string>",
          "bytes": 123
        },
        "response": {
          "content_type": "<string>",
          "bytes": 123
        }
      }
    }
  ]
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Domains

Analytics

Asset Discovery

Audit

Billing

Chat

CLI

Connectors

Containers

Assets

Test Users

Integrations

Knowledge

License

LLM

Run Logs

Organization

Invitations

Members

PR Reviews

Vulnerabilities

Repositories

Supply Chain

Scans

Schedules

Search

Tokens

Uploads

Webhooks

Workspaces

Verify a test user's login

Authorizations

Scopes

Path Parameters

Query Parameters

Body

Response