Login

Developing

Development

http://localhost:8080/api/v0

POST

/auth/login

Purpose:

Authentication with username and password.

Use:

Notes:

Two types of authentication are currently supported on the client side. Basic and Bearer/token Authentication.

Basic Authentication is NOT enabled by default, but can be in enabled in the public/scripts/env.js file by setting AUTH: "basic". Basic authnetication should NOT be used in a production environment, and only for testing and development.

The default authentication mechanism is Bearer and will be enabled on the client side when AUTH is NOT specified in the env.js file.

For more information about http authentication (https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/Authentication)

Request

Body Params application/json

Examples

Responses

🟢200Success

application/json

Successfully logged in. Will return a access token and if required a refresh token. The access token will be sent with all subsequent requests post log in.

Bodyapplication/json

🟠401Unauthorized

🟠400Bad Request

🟠422Unprocessable Entity

🟠404Not found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'http://localhost:8080/api/v0/auth/login' \
--header 'Content-Type: application/json' \
--data '{
    "username": "john.doe",
    "password": "password"
}'

Response Example

200 - Refresh token exists

{
    "token": "01988578-a111-7d4a-a675-0980f37a0b55",
    "meta_data": {
        "user_id": "68503638b86e9eb6df2875e6"
    }
}

Modified at 2025-09-19 17:49:14

auth

refresh token

Login

Purpose:#

Use:#

Notes:#

Request

Responses

Purpose:

Use:

Notes: