API Reference
You can download your own API reference by going to your instance's host and accessing it via /docs/openapi/json . example: https://canary.novel.dev/docs/openapi/json
Auth
Callback called by an authentication strategy available to the application.
Authentication successful. Redirecting to next step...
Authentication successful. Redirecting to next step...
No content
Proceed to the application after a successful MFA attempt.
Authentication successful. Redirecting to next step...
Authentication successful. Redirecting to next step...
No content
Start the sign up process.
Sign up successful. Redirecting to next step...
Sign up successful. Redirecting to next step...
Authenticate by strategy available to the application.
Authentication successful. Redirecting to next step...
Authentication successful. Redirecting to next step...
Application
Switch organization of the current session.
Switched organization successfully.
Switched organization successfully.
Switched organization successfully.
No content
Accounts
Update the currently logged in account's profile.
User profile updated successfully.
User profile updated successfully.
User profile updated successfully.
No content
Revoke a session related to the currently logged in user.
Session revoked successfully.
Session revoked successfully.
Session revoked successfully.
No content
Update the currently logged in account's settings.
User configuration updated successfully.
User configuration updated successfully.
User configuration updated successfully.
No content
Update the currently logged in account's password.
User password updated successfully.
User password updated successfully.
User password updated successfully.
No content
Attach a TOTP secret to a user for use with MFA during login.
MFA secret registered successfully.
MFA secret registered successfully.
MFA secret registered successfully.
No content
Revoke registered secret so a user can register a new one. It is possible to register and overwrite an existing mfa secret.
MFA secret revoked successfully.
MFA secret revoked successfully.
MFA secret revoked successfully.
No content
Organizations
Deactivate an organization tied to the currently logged in session.
Organization has been deactivated.
Organization has been deactivated.
Organization has been deactivated.
No content
Create a new organization tied to the user making the request.
Organization has been created.
Organization has been created.
Update the detail of the current organization.
Updated organization successfully.
Updated organization successfully.
Updated organization successfully.
No content
Revoke the invitation sent by the currently logged in user from an organization.
Invitations revoked successfully.
Invitations revoked successfully.
Invitations revoked successfully.
No content
Accept an invitation coming from an organization.
Invite accepted successfully.
Invite accepted successfully.
Invite accepted successfully.
No content
Reject an invitation coming from an organization.
Invite rejected successfully.
Invite rejected successfully.
Invite rejected successfully.
No content
Remove a member of an organization.
Member removed successfully.
Member removed successfully.
Member removed successfully.
No content
Promote a member of an organization.
Member promoted successfully.
Member promoted successfully.
Member promoted successfully.
No content
Subscription
Cancel the subscription currently applied to the organization.
Subscription cancelled successfully.
Subscription cancelled successfully.
Subscription cancelled successfully.
No content
Add the payment method related to a user.
Payment method added successfully.
Payment method added successfully.
Payment method added successfully.
No content
Remove the payment method related to a user.
Payment method removed successfully.
Payment method removed successfully.
Payment method removed successfully.
No content
Subscribe to an available plan.
Subscription created successfully.
Subscription created successfully.
Subscription created successfully.
No content
API Keys
Revoke the api key related to the currently logged in user.
API key revoked successfully.
API key revoked successfully.
API key revoked successfully.
No content
Files
If using local driver for file system. Accept file uploads.
File has been uploaded successfully.
File has been uploaded successfully.
File has been uploaded successfully.
No content
Notifications
Mark notifications as archived.
Notification archived successfully.
Notification archived successfully.
Notification archived successfully.
No content
Deregister the push token related to the user.
Token deregistered successfully.
Token deregistered successfully.
Token deregistered successfully.
No content
Register the push token related to the user.
Push token registered successfully.
Push token registered successfully.
Push token registered successfully.
No content
Mark notifications as read.
Notification marked as read successfully.
Notification marked as read successfully.
Notification marked as read successfully.
No content
Changelog
2024-12-20 - Initial Documentation
Last updated
Was this helpful?