login

User Login

This function is an API endpoint that allows a user to log in without oauth. It is tagged with "login" for OpenAPI documentation. <br>

Parameters

  • request: The request data, which includes the user's username and password. <br>

Returns

If successful, this function returns a Json<LoginReply> object, which includes the user's information and access token. <br> If the user is not authorized, this function returns a status::Unauthorized error. <br>

Errors

This function will return an error if the user is not authorized or if the system is in maintenance mode.

post/api/login

Request body

usernamestring required
passwordstring required
idstring required
uuidstring required

Response

typestring required
access_tokeninteger[] required

Changes

Changed in 2 of the 11 revisions of this API.11

    • added the required property user/admin to the response with the 200 status

      response-required-property-added

    • removed the required property user/admin from the response with the 200 status

      response-required-property-removed

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog