KAkareadita
Plugin

Authenticate with the Server given an auth key. This will log you in by returning the user object and the JWT token.

Changed on

This API is not fully built out and may require more information in later releases

post/api/Plugin/authenticate

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/Plugin/authenticate
  • Auth
    API key in header x-api-key

Query parameters

apiKeystring required

Auth key which will be used to authenticate and return a valid user token back

pluginNamestring required

Name of the Plugin

Response

OK

idinteger
oidcIdstring nullable
usernamestring nullable
emailstring nullable
rolesstring[] nullable
tokenstring nullable
refreshTokenstring nullable
apiKeystring nullable
kavitaVersionstring nullable
identityProvider0 | 1

Members:

  • 0 — Kavita
  • 1 — OpenID Connect (OpenIdConnect)
createdstring date-time
createdUtcstring date-time
coverImagestring nullable
primaryColorstring nullable
secondaryColorstring nullable

Changes

  • 20dc09733e05Revision changes
    • info

      added the optional property // to the response with the status (media type: text/plain)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: text/json)

  • 4e3330779233Revision changes
    • info

      added the required property / to the response with the status (media type: text/plain)

    • info

      added the required property / to the response with the status (media type: application/json)

    • info

      added the required property / to the response with the status (media type: text/json)

    • info

      added the required property / to the response with the status (media type: text/plain)

    • info

      added the required property / to the response with the status (media type: application/json)

    • info

      added the required property / to the response with the status (media type: text/json)