XExenforo-ltd
Auth

Look up an active user from session data

Changed on

Look up an active user from session data. This can be used to help with seamless SSO with XF, assuming the session or remember cookies are available to your page. At least one of session_id and remember_cookie must be provided. Only available to super user keys.

post/auth/from-session

Request

Request body application/x-www-form-urlencoded

session_idstring

If provided, checks for an active session with that ID.

remember_cookiestring

If provided, checks to see if this is an active "remember me" cookie value.

Response

OK

successboolean

If false, no session or remember cookie could be found

Changes

  • e271d0e41f6dRevision changes
    • breaking

      removed the media type application/json from the request body

    • info

      api operation id post_auth_from_session removed and replaced with postAuthFromSession

    • 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 postAuthFromSession removed and replaced with post_auth_from_session

    • 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

      added the media type application/json to the request body