/
KA
kareadita
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Account
28
get
/api/Account/oidc-authenticated
Returns true if OIDC authentication cookies are present and the Kavita.Server.Extensions.IdentityServiceExtensions.OpenIdConnect scheme has been registered
post
/api/Account/clear-oidc-link
Remove 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/Account
Returns the current user, as it would from login
post
/api/Account/reset-password
Update a user's password
post
/api/Account/register
Register the first user (admin) on the server. Will not do anything if an admin is already confirmed
post
/api/Account/login
Perform a login. Will send JWT Token of the logged in user back.
get
/api/Account/refresh-account
Returns an up-to-date user account
post
/api/Account/refresh-token
Refreshes the user's JWT token
get
/api/Account/roles
Get All Roles back. See Kavita.Models.Constants.PolicyConstants
post
/api/Account/update/username
Initiates the flow to update a user's username.
post
/api/Account/update/email
Initiates 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-restriction
Change the Age Rating restriction for the user
post
/api/Account/update
Update the user account. This can only affect Username, Email (will require confirming), Roles, and Library access.
get
/api/Account/invite-url
Requests the Invite Url for the AppUserId. Will return error if user is already validated.
post
/api/Account/invite
Invites 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-email
Last step in authentication flow, confirms the email token for email
post
/api/Account/confirm-email-update
Final 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-password
Will 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-email
Resend an invite to a user already invited
get
/api/Account/opds-url
Returns the OPDS url for this user
get
/api/Account/is-email-valid
Is the user's current email valid or not
get
/api/Account/auth-keys
Returns all Auth Keys with the account
post
/api/Account/rotate-auth-key
Rotate the Auth Key
post
/api/Account/create-auth-key
Creates a new Auth Key for a user.
delete
/api/Account/auth-key
Delete the Auth Key
Activity
1
Admin
1
Annotation
12
Book
4
Cbl
14
Chapter
5
Collection
12
ColorScape
3
Device
10
Download
12
Email
1
Filter
12
Font
5
Health
1
Image
15
KavitaPlusAudit
6
Koreader
3
Library
25
License
13
Locale
1
Manage
2
Metadata
14
OAuth
2
Oidc
2
Opds
22
Panels
2
Person
10
Plugin
5
Rating
4
Reader
39
ReadingList
27
ReadingProfile
16
Review
6
Scrobbling
19
Search
4
Series
33
Server
24
Settings
20
Stats
34
Stream
17
Tachiyomi
2
Theme
7
Upload
13
Users
10
Volume
4
WantToRead
4
Account
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Returns the OPDS url for this user
get
/api/Account/opds-url
Mar 22, 2026
905177999f3b
Revision changes
info
added the new optional
query
request parameter
authKeyName