Authenticate a user

post

Body

application/json

passwordstringRequired

usernamestringRequired

Responses

200

User authenticated.

application/json

201

A second authentication factor is required. Verify one of the listed methods with the matching /api/v1/auth/{method} endpoint.

application/json

401

Invalid credentials or user groups are not synced.

application/json

403

License user limit reached.

application/json

429

Too many failed login attempts for this user.

application/json

500

Unable to authenticate user.

application/json

post/api/v1/auth

HTTPcURLJavaScriptPython

POST /api/v1/auth HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "password": "some-password",
  "username": "admin"
}

{
  "url": null,
  "user": {
    "authorized_apps": [
      {
        "oauth2client_id": 1,
        "oauth2client_name": "text"
      }
    ],
    "devices": [
      {
        "configured": true,
        "created": "2026-08-07T20:51:18.248Z",
        "description": null,
        "device_type": "user",
        "id": 1,
        "name": "text",
        "user_id": 1,
        "wireguard_pubkey": "text",
        "networks": [
          {
            "device_wireguard_ips": [
              "text"
            ],
            "is_active": true,
            "last_connected_at": null,
            "last_connected_ip": null,
            "location_mfa_mode": "disabled",
            "network_gateway_ip": "text",
            "network_id": 1,
            "network_name": "text"
          }
        ]
      }
    ],
    "email": "text",
    "email_mfa_enabled": true,
    "enrolled": true,
    "first_name": "text",
    "groups": [
      "text"
    ],
    "id": 1,
    "is_active": true,
    "is_admin": true,
    "last_name": "text",
    "ldap_pass_requires_change": true,
    "mfa_enabled": true,
    "mfa_method": "None",
    "name": "text",
    "phone": null,
    "totp_enabled": true,
    "username": "text"
  }
}