Open Gauge
Auth

Login Endpoint

POST
/api/v1/auth/login

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/auth/login" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "password": "string"  }'
{  "access_token": "string",  "token_type": "bearer"}
{  "detail": [    {      "loc": [        "string"      ],      "msg": "string",      "type": "string"    }  ]}

API Reference

Open Gauge API

postRegister Endpoint

Create a local account. Every new account requires activation before it can sign in. If an admin has configured and enabled SMTP (see /admin/email-settings), activation is self-service via an emailed verification link (/auth/verify-email). Otherwise an admin must activate the account manually from Admin -> Users.