Auth

Authentication and authorization

Login

post

Body

application/x-www-form-urlencoded

grant_typeany ofOptional

stringOptionalPattern: password

or

nullOptional

usernamestringRequired

passwordstringRequired

scopestringOptionalDefault: ""

client_idany ofOptional

stringOptional

or

nullOptional

client_secretany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/auth/token

HTTPcURLJavaScriptPython

POST /auth/token HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 110

"grant_type='text'&username='text'&password='text'&scope=''&client_id='text'&client_secret='text'"

{
  "access_token": "text",
  "token_type": "bearer"
}

Change Password

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

current_passwordstringRequired

new_passwordstring · min: 8Required

new_password_confirmstring · min: 8Required

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/auth/change-password

HTTPcURLJavaScriptPython

POST /auth/change-password HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "current_password": "text",
  "new_password": "text",
  "new_password_confirm": "text"
}

No content

List Sessions

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

get

/auth/sessions

HTTPcURLJavaScriptPython

GET /auth/sessions HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

[
  {
    "id": 1,
    "ip_address": "text",
    "user_agent": "text",
    "created_at": "2025-12-30T03:11:29.746Z",
    "last_seen": "2025-12-30T03:11:29.746Z",
    "current": false
  }
]

Revoke Session

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

session_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/auth/sessions/{session_id}/revoke

HTTPcURLJavaScriptPython

POST /auth/sessions/{session_id}/revoke HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Revoke All Sessions

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

Responseany

post

/auth/sessions/revoke-all

HTTPcURLJavaScriptPython

POST /auth/sessions/revoke-all HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

No content

Logout

post

Responses

200

Successful Response

application/json

Responseany

post

/auth/logout

HTTPcURLJavaScriptPython

POST /auth/logout HTTP/1.1
Host: 
Accept: */*

200

Successful Response

No content

List Api Keys

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

get

/auth/api-keys

HTTPcURLJavaScriptPython

GET /auth/api-keys HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

[
  {
    "id": 1,
    "name": "text",
    "key_prefix": "text",
    "created_at": "2025-12-30T03:11:29.746Z",
    "last_used_at": "2025-12-30T03:11:29.746Z"
  }
]

Create Api Key

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

namestringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/auth/api-keys

HTTPcURLJavaScriptPython

POST /auth/api-keys HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": 1,
  "name": "text",
  "key": "text",
  "key_prefix": "text",
  "created_at": "2025-12-30T03:11:29.746Z"
}

Revoke Api Key

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

key_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/auth/api-keys/{key_id}

HTTPcURLJavaScriptPython

DELETE /auth/api-keys/{key_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content