XExenforo-ltd
Auth

Test a login and password for validity

Changed on

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.

post/auth/

Request

  • Base URL
    https://example.com/api
  • Auth
    • OAuth 2
      Authorization codehttps://example.com/oauth2/authorize
      Token URLhttps://example.com/api/oauth2/token
      Scopesauth:write
    • or API key in header XF-Api-Key
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

loginstring required

The username or email address of the user to test

passwordstring required

The password of the user

limit_ipstring

The IP that should be considered to be making the request. If provided, this will be used to prevent brute force attempts.

Response

OK

Changes

  • e271d0e41f6dRevision changes
    • breaking

      request body became required

    • breaking

      removed the media type application/json from the request body

    • info

      api operation id post_auth_ removed and replaced with postAuth

    • info

      the endpoint scheme security XF-Api-Key was added to the API

    • info

      the endpoint scheme security XF-OAuth2 was added to the API

    • info

      added the new optional header request parameter XF-Api-User to all path's operations

    • info

      added the new optional query request parameter api_bypass_permissions to all path's operations

  • fc0a40f3b859Revision changes
    • warning

      the optional response header XF-Latest-Api-Version removed for the status 200

    • warning

      the optional response header XF-Request-User removed for the status 200

    • warning

      the optional response header XF-Request-User-Extras removed for the status 200

    • warning

      the optional response header XF-Used-Api-Version removed for the status 200

    • info

      api operation id postAuth removed and replaced with post_auth_

    • info

      the endpoint scheme security XF-Api-Key was removed from the API

    • info

      the endpoint scheme security XF-OAuth2 was removed from the API

    • info

      request body became optional

    • info

      added the media type application/json to the request body