/

Docs
History
Schema
Generate

Filter operations

Account28

get/api/Account/oidc-authenticatedReturns true if OIDC authentication cookies are present and the Kavita.Server.Extensions.IdentityServiceExtensions.OpenIdConnect scheme has been registered
post/api/Account/clear-oidc-linkRemove the OIDC link for the authenticated user. This action will also remove the authentication cookie. The caller should take note and redirect to login if no other authentication is currently present (I.e. JWT)
get/api/AccountReturns the current user, as it would from login
post/api/Account/reset-passwordUpdate a user's password
post/api/Account/registerRegister the first user (admin) on the server. Will not do anything if an admin is already confirmed
post/api/Account/loginPerform a login. Will send JWT Token of the logged in user back.
get/api/Account/refresh-accountReturns an up-to-date user account
post/api/Account/refresh-tokenRefreshes the user's JWT token
get/api/Account/rolesGet All Roles back. See Kavita.Models.Constants.PolicyConstants
post/api/Account/update/usernameInitiates the flow to update a user's username.
post/api/Account/update/emailInitiates the flow to update a user's email address. If email is not setup, then the email address is not changed in this API. A confirmation link is sent/dumped which will validate the email. It must be confirmed for the email to update.
post/api/Account/update/age-restrictionChange the Age Rating restriction for the user
post/api/Account/updateUpdate the user account. This can only affect Username, Email (will require confirming), Roles, and Library access.
get/api/Account/invite-urlRequests the Invite Url for the AppUserId. Will return error if user is already validated.
post/api/Account/inviteInvites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup.
post/api/Account/confirm-emailLast step in authentication flow, confirms the email token for email
post/api/Account/confirm-email-updateFinal step in email update change. Given a confirmation token and the email, this will finish the email change.
post/api/Account/confirm-password-reset
post/api/Account/forgot-passwordWill send user a link to update their password to their email or prompt them if not accessible
get/api/Account/email-confirmed
post/api/Account/confirm-migration-email
post/api/Account/resend-confirmation-emailResend an invite to a user already invited
get/api/Account/opds-urlReturns the OPDS url for this user
get/api/Account/is-email-validIs the user's current email valid or not
get/api/Account/auth-keysReturns all Auth Keys with the account
post/api/Account/rotate-auth-keyRotate the Auth Key
post/api/Account/create-auth-keyCreates a new Auth Key for a user.
delete/api/Account/auth-keyDelete the Auth Key

Activity1

Admin1

Annotation12

Book4

Cbl14

Chapter5

Collection12

ColorScape3

Device10

Download12

Email1

Filter12

Font5

Health1

Image15

KavitaPlusAudit6

Koreader3

Library25

License13

Locale1

Manage2

Metadata14

OAuth2

Oidc2

Opds22

Panels2

Person10

Plugin5

Rating4

Reader39

ReadingList27

ReadingProfile16

Review6

Scrobbling19

Search4

Series33

Server24

Settings20

Stats34

Stream17

Tachiyomi2

Theme7

Upload13

Users10

Volume4

WantToRead4

Account

Changes to Delete the Auth Key

delete/api/Account/auth-key

Dec 13, 2025ba8553c39654 Revision changes
- info
  endpoint added