Login

POST

/~/api/login

clear-text login

Request

Header Params

Body Params application/json

Example

{
    "username": "string",
    "password": "string",
    "allow_session_ip_change": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'http://localhost/~/api/login' \
--header 'x-hfs-anti-csrf: 1' \
--header 'Content-Type: application/json' \
--data '{
    "username": "string",
    "password": "string",
    "allow_session_ip_change": true
}'

Responses

🟢200

application/json

Bodyapplication/json

Example

{
    "username": "string",
    "expandedUsername": [
        "string"
    ],
    "adminUrl": "string",
    "canChangePassword": true,
    "requireChangePassword": true,
    "exp": "2019-08-24T14:15:22.123Z",
    "accountExp": "2019-08-24T14:15:22.123Z",
    "redirect": "string"
}

Modified at 2026-11-05 17:14:45

Refresh session