Skip to main content

Test a login and password for validity

POST 
/auth/

Test a login and password for validity. Only available to super user keys. We strongly recommend the login and password parameters are passed into the request body rather than the query string.

Request​

Responses​

OK

Response Headers
    XF-Latest-Api-Version

    The latest API version available.

    XF-Used-Api-Version

    The API version used to render the response.

    XF-Request-User

    The user ID of the request user.

    XF-Request-User-Extras

    Additional information about the request user in JSON encoding. Requires XF-Request-User header to be non-zero.