/
KA
kareadita
/
Kavita
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 19m ago · Updated 3d ago
View markdown
Account
28
get
Returns true if OIDC authentication cookies are present and the Kavita.Server.Extensions.IdentityServiceExtensions.OpenIdConnect scheme has been registered
post
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
Returns the current user, as it would from login
post
Update a user's password
post
Register the first user (admin) on the server. Will not do anything if an admin is already confirmed
post
Perform a login. Will send JWT Token of the logged in user back.
get
Returns an up-to-date user account
post
Refreshes the user's JWT token
get
Get All Roles back. See Kavita.Models.Constants.PolicyConstants
post
Initiates the flow to update a user's username.
post
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
Change the Age Rating restriction for the user
post
Update the user account. This can only affect Username, Email (will require confirming), Roles, and Library access.
get
Requests the Invite Url for the AppUserId. Will return error if user is already validated.
post
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
Last step in authentication flow, confirms the email token for email
post
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
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
Resend an invite to a user already invited
get
Returns the OPDS url for this user
get
Is the user's current email valid or not
get
Returns all Auth Keys with the account
post
Rotate the Auth Key
post
Creates a new Auth Key for a user.
delete
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
5
Koreader
3
Library
23
License
13
Locale
1
Manage
1
Metadata
14
OAuth
2
Oidc
2
Opds
22
Panels
2
Person
10
Plugin
5
Rating
4
Reader
39
ReadingList
27
ReadingProfile
16
Review
5
Scrobbling
18
Search
4
Series
33
Server
18
Settings
20
Stats
34
Stream
17
Tachiyomi
2
Theme
7
Upload
10
Users
10
Volume
4
WantToRead
4
Account
Initiates the flow to update a user's username.
post
/api/Account/update/username
Request body
UpdateUsernameRequestDto
required
username
string
nullable
required
Response
OK
InviteUserResponse
required
emailLink
string
nullable
emailSent
boolean
invalidEmail
boolean