Auth

get

Login methods

Authorizations

sessionidstringOptional

Log in using the POST /api/v1/auth/ endpoint

Responses

200

Success: Login methods

application/json

username_password_enabledbooleanRequired

session_timeoutintegerRequired

get/api/v1/auth/

GET /api/v1/auth/ HTTP/1.1
Accept: */*

200

Success: Login methods

{
  "username_password_enabled": true,
  "oidc_providers": [
    {
      "provider": "text",
      "url": "text"
    }
  ],
  "session_timeout": 1
}

post

Sign in as Syntho user

Authorizations

sessionidstringOptional

Log in using the POST /api/v1/auth/ endpoint

Body

emailstring · email · max: 255Required

passwordstring · min: 8 · max: 64Required

Responses

201

Success: Session Created

application/json

new_password_requiredbooleanRequired

pkintegerRequired

400

Error Bad Request: Invalid Credentials

application/json

401

Error: Unauthorized - this error means you submit an old (invalid) token alongside the login request.

application/json

post/api/v1/auth/

POST /api/v1/auth/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "email": "[e-mail]",
  "password": "text"
}

{
  "new_password_required": true,
  "pk": 1
}

delete

Sign out

Authorizations

sessionidstringOptional

Log in using the POST /api/v1/auth/ endpoint

Responses

200

Success: Session Deleted

application/json

statusstringOptionalDefault: OK

401

Error: Unauthorized

application/json

delete/api/v1/auth/

DELETE /api/v1/auth/ HTTP/1.1
Accept: */*

{
  "status": "OK"
}