# KeyAuth ## Docs - Overview [KeyAuth - Security Pratices](https://keyauthdocs.apidog.io/overview/security-pratices.md): - Overview [Premade Examples - SDKS](https://keyauthdocs.apidog.io/overview/examples.md): - Overview [QnA](https://keyauthdocs.apidog.io/overview/qna.md): - Overview [Rate Limiting](https://keyauthdocs.apidog.io/overview/rate-limiting.md): - API > Displaying Data [Displaying Data](https://keyauthdocs.apidog.io/api/displayingdata.md): - [Seller API](https://keyauthdocs.apidog.io/folder-819595.md): - Seller API [Application Settings](https://keyauthdocs.apidog.io/folder-819666.md): - Custom Domain Setup [Custom Domain (API) ](https://keyauthdocs.apidog.io/customdomain/setup.md): ## API Docs - API > Getting Started > License [KeyAuth - License Login](https://keyauthdocs.apidog.io/api/getting-started/license/license-login.md): Register and log in with just a license. Once the license is used for the first time, users will only need to use the license to access the application. - API > Getting Started > License [KeyAuth - Redeem license (upgrade)](https://keyauthdocs.apidog.io/api/getting-started/license/redeem-license.md): Assign an unused license to a user. - API > Getting Started [KeyAuth - Initialization](https://keyauthdocs.apidog.io/api/getting-started/initialization.md): :::info - API > Getting Started [KeyAuth - Login](https://keyauthdocs.apidog.io/api/getting-started/login.md): Log into the application using a username and password. - API > Getting Started [KeyAuth - Logout](https://keyauthdocs.apidog.io/api/getting-started/logout.md): Log out of the application. This will end the session and require the user to login again. - API > Getting Started [KeyAuth - Register](https://keyauthdocs.apidog.io/api/getting-started/register.md): Register an account using a username, password, license, and email (optional) - API > Features > Chatroom/Messages [KeyAuth - Retrieve Messages](https://keyauthdocs.apidog.io/api/features/chatroom/messages/retrieve-messages.md): Receive messages from the chat channel. - API > Features > Chatroom/Messages [KeyAuth - Send Messages](https://keyauthdocs.apidog.io/api/features/chatroom/messages/send-messages.md): Allow users to send messages to a chat channel. - API > Features > User Variables [KeyAuth - Retrieve User Variable](https://keyauthdocs.apidog.io/api/features/user/variables/retrieve-user-variable.md): Retrieve the user variable data assigned to the user - API > Features > User Variables [KeyAuth - Set User Variable](https://keyauthdocs.apidog.io/api/features/user/variables/set-user-variable.md): Set a user variable. This variable contains data that will be accessible by this user. - API > Features [KeyAuth - Ban User](https://keyauthdocs.apidog.io/api/features/ban-user.md): Ban a user from your application - API > Features [KeyAuth - Check Blacklist](https://keyauthdocs.apidog.io/api/features/check-blacklist.md): Check if the user is blacklisted or not. - API > Features [KeyAuth - Check Session](https://keyauthdocs.apidog.io/api/features/check-session.md): Check to see if a session is valid or not - API > Features [Disable 2FA](https://keyauthdocs.apidog.io/api/features/disable2fa.md): Disable Two Factor Authentication(2fa) on a client account. - API > Features [KeyAuth - Change Username](https://keyauthdocs.apidog.io/api/features/change-username.md): Allow the user to change their username. - API > Features [KeyAuth - Download File](https://keyauthdocs.apidog.io/api/features/download-file.md): Allow users to downloaded files. - API > Features [Enable 2FA](https://keyauthdocs.apidog.io/api/features/enable2fa.md): Enable Two Factor Authentication(2fa) on a client account. - API > Features [KeyAuth - Fetch Online Users](https://keyauthdocs.apidog.io/api/features/fetch-online-users.md): Fetch all online users. (active sessions) - API > Features [KeyAuth - Forgot Password](https://keyauthdocs.apidog.io/api/features/forgot-password.md): Allow users to reset their password if they forgot it. The user must have entered an email when registering an account or else they will be unable to reset their password until an email is assigned. - API > Features [KeyAuth - Fetch Stats](https://keyauthdocs.apidog.io/api/features/fetch-stats.md): Run this function first to retrieve all stored stats. - API > Features [KeyAuth - Log](https://keyauthdocs.apidog.io/api/features/log.md): Log events from your application. - API > Features [KeyAuth - Webhook](https://keyauthdocs.apidog.io/api/features/webhook.md): Send requests securely from KeyAuth server - API > Features [KeyAuth - Retrieve Global Variable](https://keyauthdocs.apidog.io/api/features/retrieve-global-variable.md): Retrieve a global variable. - Seller API > Application Settings [KeyAuth - Add Application Hash](https://keyauthdocs.apidog.io/sellerapi/application-settings/add-application-hash.md): Add a hash to an application to prevent any users from running modified versions of an application. - Seller API > Application Settings [KeyAuth - Edit Application Settings](https://keyauthdocs.apidog.io/sellerapi/application-settings/edit-application-settings.md): Edit an applications settings (app version, permissions, custom responses etc) - Seller API > Application Settings [KeyAuth - Retrieve Application Details](https://keyauthdocs.apidog.io/sellerapi/application-settings/retrieve-application-details.md): Retrieve the information from an application - Seller API > Application Settings [KeyAuth - Retrieve Current Application Settings](https://keyauthdocs.apidog.io/sellerapi/application-settings/retrieve-current-application-settings.md): Retrieve the current application settings. - Seller API > Application Settings [Retrieve Stats](https://keyauthdocs.apidog.io/sellerapi/application-settings/retrieve-stats.md): Retrieve stats from an application. - Seller API > Application Settings [KeyAuth - Pause Application](https://keyauthdocs.apidog.io/sellerapi/application-settings/pause-application.md): Pause an application and prevent users from logging in until the application is unpaused. - Seller API > Application Settings [KeyAuth - Reset Application Hash](https://keyauthdocs.apidog.io/sellerapi/application-settings/reset-application-hash.md): Reset an applications hash. - Seller API > Application Settings [KeyAuth - Unpause Application](https://keyauthdocs.apidog.io/sellerapi/application-settings/unpause-application.md): Allow users to access an application again. - Seller API > Blacklists [KeyAuth - Create New Blacklist](https://keyauthdocs.apidog.io/sellerapi/blacklist/create-new-blacklist.md): Add a IP or a HWID to the blacklist. - Seller API > Blacklists [KeyAuth - Delete An Existing Blacklist](https://keyauthdocs.apidog.io/sellerapi/blacklist/delete-existing-blacklist.md): Delete a IP or a HWID from the blacklist. - Seller API > Blacklists [KeyAuth - Delete All Blacklists](https://keyauthdocs.apidog.io/sellerapi/blacklist/delete-all-blacklists.md): Delete all blacklisted IPs and HWIDs - Seller API > Blacklists [KeyAuth - Retrieve All Blacklists](https://keyauthdocs.apidog.io/sellerapi/blacklist/retrieve-all-blacklists.md): Retrieve all blacklisted IPs and HWIDs - Seller API > Chats [KeyAuth - Create A New Chat Channel](https://keyauthdocs.apidog.io/sellerapi/chats/create-a-new-chat-channel.md): Create a new chatroom channel to allow messages to be sent too. - Seller API > Chats [KeyAuth - Delete Channel Messages](https://keyauthdocs.apidog.io/sellerapi/chats/delete-channel-messages.md): Delete all messages in a chat channel. - Seller API > Chats [KeyAuth - Delete Existing Chat Channel](https://keyauthdocs.apidog.io/sellerapi/chats/delete-existing-chat-channel.md): Delete an existing chat channel. This will also delete all messages in this channel. - Seller API > Chats [KeyAuth - Edit Existing Chat Channel](https://keyauthdocs.apidog.io/sellerapi/chats/edit-existing-chat-channel.md): Edit an existing chat channel. - Seller API > Chats [KeyAuth - Retrieve All Mutes](https://keyauthdocs.apidog.io/sellerapi/chats/retrieve-all-mutes.md): Retrieve all users that are currently muted on the chat. - Seller API > Chats [KeyAuth - Retrieve All Chat Channels](https://keyauthdocs.apidog.io/sellerapi/chats/retrieve-all-chat-channels.md): Retrieve all existing chat channels. - Seller API > Chats [KeyAuth - Mute A User](https://keyauthdocs.apidog.io/sellerapi/chats/mute-user.md): Mute a user from chatting for a specific duration. - Seller API > Chats [KeyAuth - Unmute A User](https://keyauthdocs.apidog.io/sellerapi/chats/unmute-user.md): Unmute a user and allow them to chat again in the chat channel. - Seller API > Files [KeyAuth - Delete Existing File](https://keyauthdocs.apidog.io/sellerapi/files/delete-existing-file.md): Delete an existing file. - Seller API > Files [KeyAuth - Delete All Files](https://keyauthdocs.apidog.io/sellerapi/files/delete-all-files.md): Delete all files on an application. - Seller API > Files [KeyAuth - Retrieve All Files](https://keyauthdocs.apidog.io/sellerapi/files/retrieve-all-files.md): Retrieve all existing files on an application. - Seller API > Files [KeyAuth -Retrieve An Existing File](https://keyauthdocs.apidog.io/sellerapi/files/retrieve-a-file.md): Retrieve An Existing File - Seller API > Files [KeyAuth - Edit An Existing File](https://keyauthdocs.apidog.io/sellerapi/files/edit-a-file.md): Edit an existing file on an application. - Seller API > Files [KeyAuth - Upload A New FIle](https://keyauthdocs.apidog.io/sellerapi/files/upload-new-file.md): Upload a new file. Files must end in an extension (.exe, .rar for example) - Seller API > Global Variables [KeyAuth - Create A New Global Variable](https://keyauthdocs.apidog.io/sellerapi/global-variables/create-new-global-variable.md): Create a new global variable. This can be retrieved by any user! - Seller API > Global Variables [KeyAuth - Delete A Global Variable](https://keyauthdocs.apidog.io/sellerapi/global-variables/delete-global-variable.md): Delete a global variable - Seller API > Global Variables [KeyAuth - Delete All Global Variables](https://keyauthdocs.apidog.io/sellerapi/global-variables/delete-all-global-variables.md): Delete all global variables. - Seller API > Global Variables [KeyAuth - Edit Existing Global Variable](https://keyauthdocs.apidog.io/sellerapi/global-variables/edit-existing-global-variable.md): Edit an existing global variable. - Seller API > Global Variables [KeyAuth - Retrieve All Global Variables](https://keyauthdocs.apidog.io/sellerapi/global-variables/retrieve-all-global-variables.md): Retrieve all global variables. - Seller API > Global Variables [KeyAuth - Retrieve Existing Global Variable](https://keyauthdocs.apidog.io/sellerapi/global-variables/retrieve-existing-global-variable.md): Retrieve an existing global variable. - Seller API > Licenses [KeyAuth - Add Time To All Unused Licenses](https://keyauthdocs.apidog.io/sellerapi/licenses/add-time-to-all-unused-licenses.md): Add time to all licenses that are not being used. This will add the time given to whatever the existing time is on the license. - Seller API > Licenses [KeyAuth - Assign A License To A User](https://keyauthdocs.apidog.io/sellerapi/licenses/assigned-license-to-user.md): Assign a license to a user. - Seller API > Licenses [KeyAuth - Ban License](https://keyauthdocs.apidog.io/sellerapi/licenses/ban-license.md): Ban a license and preventing them from logging into an application. - Seller API > Licenses [KeyAuth - Create New License](https://keyauthdocs.apidog.io/sellerapi/licenses/create-new-license.md): Create a new license - Seller API > Licenses [KeyAuth - Create A New User Using A License](https://keyauthdocs.apidog.io/sellerapi/licenses/create-new-user-using-license.md): Create a new user using an existing license. - Seller API > Licenses [KeyAuth - Delete All Licenses](https://keyauthdocs.apidog.io/sellerapi/licenses/delete-all-licenses.md): Delete all licenses - Seller API > Licenses [Delete An Existing License](https://keyauthdocs.apidog.io/sellerapi/licenses/delete-license.md): Delete an existing license - Seller API > Licenses [KeyAuth - Delete Multiple Licenses](https://keyauthdocs.apidog.io/sellerapi/licenses/delete-multiple-licenses.md): Delete multiple licences at once. - Seller API > Licenses [KeyAuth - Delete All Used Licenses](https://keyauthdocs.apidog.io/sellerapi/licenses/delete-all-used-licenses.md): Delete all used licenses - Seller API > Licenses [KeyAuth - Delete All Unused Licenses](https://keyauthdocs.apidog.io/sellerapi/licenses/delete-all-unused-licenses.md): Delete all unused licenses. - Seller API > Licenses [KeyAuth - Retrieve All Licenses](https://keyauthdocs.apidog.io/sellerapi/licenses/retrieve-all-licenses.md): Retrieve All Licenses - Seller API > Licenses [KeyAuth - Retrieve License Information](https://keyauthdocs.apidog.io/sellerapi/licenses/retrieve-license-information.md): Retrieving information about a license - Seller API > Licenses [Set Note On Existing License](https://keyauthdocs.apidog.io/sellerapi/licenses/set-note-on-license.md): Set a note on an existing license - Seller API > Licenses [Unban A License](https://keyauthdocs.apidog.io/sellerapi/licenses/unban-license.md): Unban a license. - Seller API > Licenses [KeyAuth - Verify License Exists](https://keyauthdocs.apidog.io/sellerapi/licenses/verify-license-exists.md): Verify the existence of a license on an application. - Seller API > Logs [Retrieve All Logs](https://keyauthdocs.apidog.io/sellerapi/logs/retrieve-all-logs.md): Retrieve all logs sent by using the .log function. - Seller API > Logs [Delete All Logs](https://keyauthdocs.apidog.io/sellerapi/logs/delete-all-logs.md): Delete all logs sent by using the .log function. - Seller API > Sessions [KeyAuth - End Session](https://keyauthdocs.apidog.io/sellerapi/sessions/end-session.md): End an active session. This will log the user out and require them to login again to access the application. - Seller API > Sessions [KeyAuth - End All Sessions](https://keyauthdocs.apidog.io/sellerapi/sessions/end-all-sessions.md): End all sessions. This will log everyone out of the application and require them to login again to access the application. - Seller API > Sessions [KeyAuth - Retrieve All Sessions](https://keyauthdocs.apidog.io/sellerapi/sessions/retrieve-all-sessions.md): Retrieve all active sessions - Seller API > Subscriptions [KeyAuth - Create A New Subscription](https://keyauthdocs.apidog.io/sellerapi/subscriptions/create-new-subscription.md): Create a new subscription. - Seller API > Subscriptions [KeyAuth - Delete A Subscription](https://keyauthdocs.apidog.io/sellerapi/subscriptions/delete-subscription.md): Delete an existing subscription. - Seller API > Subscriptions [KeyAuth - Edit Subscritpion](https://keyauthdocs.apidog.io/sellerapi/subscriptions/edit-subscription.md): Edit an existing subscription. - Seller API > Subscriptions [KeyAuth - Retrieve All Subscriptions](https://keyauthdocs.apidog.io/sellerapi/subscriptions/retrieve-all-subscritpions.md): Retrieve all subscriptions - Seller API > Subscriptions [KeyAuth - Pause Subscription](https://keyauthdocs.apidog.io/sellerapi/subscriptions/pause-subscription.md): Pause a subscription, preventing users with this subscription to access the application. - Seller API > Subscriptions [KeyAuth - Unpause Subscription](https://keyauthdocs.apidog.io/sellerapi/subscriptions/unpause-subscription.md): Unpause an existing subscription, allowing users that have this subscription to access the application. - Seller API > Users [KeyAuth - Add HWID To User](https://keyauthdocs.apidog.io/sellerapi/users/add-hwid-to-user.md): Add a new HWID to an existing user. - Seller API > Users [KeyAuth - Ban User](https://keyauthdocs.apidog.io/sellerapi/users/ban-user.md): Ban a user and prevent them from logging into an application. - Seller API > Users [KeyAuth - Create A New User](https://keyauthdocs.apidog.io/sellerapi/users/create-new-user.md): Create a new user - Seller API > Users [KeyAuth - Change Users Password](https://keyauthdocs.apidog.io/sellerapi/users/change-password.md): Change the password of a user - Seller API > Users [KeyAuth - Change Users Email](https://keyauthdocs.apidog.io/sellerapi/users/change-email.md): Change the email address of a user - Seller API > Users [KeyAuth - Change Users Username](https://keyauthdocs.apidog.io/sellerapi/users/change-username.md): Change the username of a user. This will end the users' sessions and require them to login again. - Seller API > Users [KeyAuth - Delete User](https://keyauthdocs.apidog.io/sellerapi/users/delete-user.md): Delete an existing user - Seller API > Users [KeyAuth - Delete All Expired Users](https://keyauthdocs.apidog.io/sellerapi/users/delete-all-expired-users.md): Delete all users that are expired. - Seller API > Users [KeyAuth - Delete A Users Variable](https://keyauthdocs.apidog.io/sellerapi/users/delete-user-variable.md): Delete the variable assigned to a user. (User variable) - Seller API > Users [KeyAuth - Delete All User Variables With Variable Name](https://keyauthdocs.apidog.io/sellerapi/users/delete-all-user-variables-with-name.md): Delete all user variables by using just the user variable name - Seller API > Users [KeyAuth - Delete A Users Subscription](https://keyauthdocs.apidog.io/sellerapi/users/delete-user-subscription.md): Remove a subscription that is assigned to a user - Seller API > Users [KeyAuth - Delete All Users](https://keyauthdocs.apidog.io/sellerapi/users/delete-all-users.md): Delete all users - Seller API > Users [KeyAuth - Extend Users Subscription](https://keyauthdocs.apidog.io/sellerapi/users/extend-users-subscription.md): Extend the expiration time of users - Seller API > Users [KeyAuth - Pause A User](https://keyauthdocs.apidog.io/sellerapi/users/pause-user.md): Pause a user, preventing them from logging into an application. This will also pause the subscription assigned to the user. - Seller API > Users [KeyAuth - Retrieve All Users](https://keyauthdocs.apidog.io/sellerapi/users/retrieve-all-users.md): Retrieve all users - Seller API > Users [KeyAuth - Retrieve All Users Variables](https://keyauthdocs.apidog.io/sellerapi/users/retrieve-all-users-variables.md): Retrieve all of the user variables - Seller API > Users [KeyAuth - Retrieve All Usernames](https://keyauthdocs.apidog.io/sellerapi/users/retrieve-all-usernames.md): Retrieve all usernames - Seller API > Users [KeyAuth - Retrieve Users Subscriptions](https://keyauthdocs.apidog.io/sellerapi/users/retrieve-subscriptions.md): Retrieve the number of users with a specific subscription. - Seller API > Users [KeyAuth - Retrieve License From User](https://keyauthdocs.apidog.io/sellerapi/users/retrieve-license-from-user.md): Retrieve the license that is currently assigned to a user. - Seller API > Users [KeyAuth - Retrieve User Variable Data](https://keyauthdocs.apidog.io/sellerapi/users/retrive-user-variable-data.md): Retrieve the data of a user variable - Seller API > Users [KeyAuth - Reset Users HWID](https://keyauthdocs.apidog.io/sellerapi/users/reset-users-hwid.md): If a user logged into their account from a different device and now is HWID locked, resetting their HWID will allow them to gain access to their account again. - Seller API > Users [KeyAuth - Reset All Users HWID](https://keyauthdocs.apidog.io/sellerapi/users/reset-all-users-hwid.md): Reset the HWID of all users. - Seller API > Users [KeyAuth - Retrieve User Data](https://keyauthdocs.apidog.io/sellerapi/users/retrieve-user-data.md): Retrieve information about a user - Seller API > Users [KeyAuth - Retrieve User Variable](https://keyauthdocs.apidog.io/sellerapi/users/set-user-variable.md): Set a user variable - Seller API > Users [KeyAuth - Substract Time From Users Subscription](https://keyauthdocs.apidog.io/sellerapi/users/subtract-time-from-users-subscription.md): Subtract time from a users expiration. - Seller API > Users [KeyAuth - Set Users HWID Reset Cooldown](https://keyauthdocs.apidog.io/sellerapi/users/set-users-hwid-reset-cooldown.md): Set a cooldown for the amount of time between each HWID reset. - Seller API > Users [KeyAuth - Unban User](https://keyauthdocs.apidog.io/sellerapi/users/unban-user.md): Unban a user, allowing them to access an application. - Seller API > Users [KeyAuth - Pause User](https://keyauthdocs.apidog.io/sellerapi/users/unpause-user.md): Unpause a user, allowing them to gain access to an application - Seller API > Users [KeyAuth - Verify User Exists](https://keyauthdocs.apidog.io/sellerapi/users/verify-user-exists.md): Verify if a user exists or not - Seller API > Webhooks [KeyAuth - Create A New Webhook](https://keyauthdocs.apidog.io/sellerapi/webhooks/create-new-webhook.md): Create a new webhook. - Seller API > Webhooks [KeyAuth - Delete All Webhooks](https://keyauthdocs.apidog.io/sellerapi/webhooks/delete-all-webhooks.md): Delete all webhooks - Seller API > Webhooks [Delete Webhook](https://keyauthdocs.apidog.io/api-14628786.md): Delete webhook - Seller API > Webhooks [KeyAuth - Retrieve All Webhooks](https://keyauthdocs.apidog.io/sellerapi/webhooks/retrieve-all-webhooks.md): Retrieve All Webhooks - Seller API > Web Loader [KeyAuth - Create A New Webloader](https://keyauthdocs.apidog.io/sellerapi/webloader/create-new-webloader.md): Create a new web loader button. - Seller API > Web Loader [KeyAuth - Delete A Webloader](https://keyauthdocs.apidog.io/sellerapi/webloader/delete-webloader.md): Delete a web loader button - Seller API > Web Loader [Delete All Web Loader Buttons](https://keyauthdocs.apidog.io/sellerapi/webloader/delete-all-web-loader-buttons.md): Delete all web loader buttons. - Seller API > Web Loader [KeyAuth - Retrieve All Web Loader Buttons](https://keyauthdocs.apidog.io/sellerapi/webloader/retrieve-web-loader-buttons.md): Retrieve all web loader buttons - Seller API > Whitelists [KeyAuth - Add IP To Whitelist](https://keyauthdocs.apidog.io/sellerapi/whitelists/add-ip-to-whitelist.md): Add a new IP to the whitelist - Seller API > Whitelists [Delete All Whitelists](https://keyauthdocs.apidog.io/sellerapi/whitelists/delete-all-whitelists.md): Delete all whitelists - Seller API > Whitelists [KeyAuth - Delete IP Whitelist](https://keyauthdocs.apidog.io/sellerapi/whitelists/delete-ip-whitelist.md): Delete an existing whitelisted IP - Seller API > Reseller/Manager Accounts [KeyAuth - Add Balance To Reseller](https://keyauthdocs.apidog.io/sellerapi/reseller-manager/add-balance-to-reseller.md): - Seller API > Reseller/Manager Accounts [KeyAuth - Create A New Reseller Or Manager](https://keyauthdocs.apidog.io/sellerapi/reseller-manager/create-new-reseller-manager.md): Create a new reseller or manager account. - Seller API > Reseller/Manager Accounts [KeyAuth - Delete A Reseller Or Manager](https://keyauthdocs.apidog.io/sellerapi/reseller-manager/delete-reseller-manager.md): Delete a reseller or manager account. - Seller API > Reseller/Manager Accounts [Retrieve All Resellers and Managers](https://keyauthdocs.apidog.io/sellerapi/reseller-manager/retrieve-all-resellers-and-managers.md): Retrieve all Resellers and Managers - Seller API > Reseller/Manager Accounts [KeyAuth - Retrieve Reseller Balance](https://keyauthdocs.apidog.io/sellerapi/reseller-manager/retrieve-reseller-balance.md): Retrieve the balance from a reseller