Sign in with username

QA Environment

POST

/api/auth/sign-in/username

Auth/Sign In

Last modified:2026-09-30 06:23:27

Maintainer:José María Esparza Arévalo

Required Permission(s):NONE

Signs in with username (case-insensitive) and password and sets the session cookie. If the user has 2FA enabled, returns TwoFactorChallenge instead of a session. Banned users get 403 BANNED_USER.

Request

Authorization

API Key

Add parameter in cookie

kio-link-bms.session_token

Example:

kio-link-bms.session_token: ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "username": "string",
    "password": "pa$$word",
    "rememberMe": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/auth/sign-in/username' \
--header 'Origin: {{bmsOrigin}}' \
--header 'Content-Type: application/json' \
--data '{
    "username": "string",
    "password": "pa$$word",
    "rememberMe": true
}'

Responses

🟢200

application/json

Success

Bodyapplication/json

Example

{
    "redirect": false,
    "token": "string",
    "url": "string",
    "user": {
        "id": "string",
        "name": "string",
        "email": "user@example.com",
        "emailVerified": true,
        "image": "string",
        "username": "string",
        "displayUsername": "string",
        "twoFactorEnabled": true,
        "role": "superAdmin",
        "banned": true,
        "banReason": "string",
        "banExpires": "2019-08-24T14:15:22.123Z",
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z"
    }
}

🟠400AuthBadRequest

🟠401AuthUnauthorized

🟠403AuthForbidden

🟠429AuthTooManyRequests

Modified at 2026-09-30 06:23:27

Sign out