Authenticates access and generates the token

POST

/api/login

Requisição

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢200OK

application/json

Access token successfully generated. Contains the list of organizations the user has access to, as well as access permissions. When using the "remember_device" feature, a cookie will be attached, which must be saved in the browser.

Body

🟠403Proibido

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "corp": "string",
    "login": "string",
    "password": "pa$$word",
    "two_factor_code": 0,
    "remember_device": true
}'

Response Example

{
    "access_token": "eyJ0eXAiOiJKV1QiLCsSnFsbzNySkydiI6...",
    "token_type": "bearer",
    "expires_in": 3600,
    "credentials": {
        "user": {
            "id": "93c1b90d-51a9-4b8b-b867-7a5ebe3ef882",
            "name": "James A. Packard",
            "email": "james.packard@mail.example.net",
            "login": "jamesp",
            "status": true,
            "two_factor_required": true,
            "corps": {
                "property1": {
                    "id": "65a149e5-cf6b-4d67-89d0-b651f82f7abe",
                    "company_name": "Acme Company"
                },
                "property2": {
                    "id": "65a149e5-cf6b-4d67-89d0-b651f82f7abe",
                    "company_name": "Acme Company"
                }
            }
        },
        "corp": "65a149e5-cf6b-4d67-89d0-b651f82f7abe",
        "permission": {
            "admin": [
                "*",
                "hliberty.auth",
                "hliberty.city",
                "hliberty.contract",
                "hliberty.corp",
                "hliberty.workgroup"
            ],
            "allow": [
                "*",
                "127.0.0.1:8001/api/corp/GET",
                "127.0.0.1:8001/api/corp/POST",
                "127.0.0.1:8001/api/corp/{id}/DELETE",
                "127.0.0.1:8001/api/corp/{id}/GET"
            ]
        }
    }
}

Modificado em 2025-09-12 14:53:25

Página anterior

Retona a lista todas as faixas de IP seguros.

Próxima página

Log the user out (invalidate the token).