> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.authlyx.dev/v3/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.authlyx.dev/_mcp/server. # V3 - Beta ## Docs - [Overview](https://docs.authlyx.dev/v3/overview.md): Guides, SDK examples, and API references for your AuthlyX integration. - [Create an account](https://docs.authlyx.dev/v3/guides/create-account.md): Set up the account you will use to manage your applications. - [Create an application](https://docs.authlyx.dev/v3/guides/create-application.md): Create the app record that your software will connect to. - [Connect your first app](https://docs.authlyx.dev/v3/guides/quickstart.md): Initialize an application and test a license login. - [How AuthlyX works](https://docs.authlyx.dev/v3/guides/how-authlyx-works.md): What you manage in AuthlyX and what happens when someone opens your app. - [How software licensing works](https://docs.authlyx.dev/v3/guides/software-licensing.md): Understand what a license represents, how access is checked and what happens when it expires. - [Choose how customers sign in](https://docs.authlyx.dev/v3/guides/access-methods.md): Pick license, username and password, or device login for your app. - [Supported languages and frameworks](https://docs.authlyx.dev/v3/guides/supported-platforms.md): Choose a supported AuthlyX SDK and check the runtime before integrating. - [Device login without a login form](https://docs.authlyx.dev/v3/guides/device-login.md): Approve a system ID in the dashboard, then let the matching installation sign in. - [Sessions and heartbeats](https://docs.authlyx.dev/v3/guides/sessions.md): Sessions and heartbeats in AuthlyX, with examples and troubleshooting. - [Offline access](https://docs.authlyx.dev/v3/guides/offline.md): Server-controlled access when a connection is unavailable. - [Plans and access](https://docs.authlyx.dev/v3/guides/plans-and-access.md): Understand how customer plans relate to licenses, users and devices. - [Features and metadata](https://docs.authlyx.dev/v3/guides/features-metadata.md): Set plan permissions and keep details on each customer identity. - [Cloud Variables](https://docs.authlyx.dev/v3/guides/cloud-variables.md): Change a shared app setting without rebuilding the app. - [Remote Scripts](https://docs.authlyx.dev/v3/guides/scripts.md): Publish signed text that your own app can fetch and interpret. - [Updates and release channels](https://docs.authlyx.dev/v3/guides/updates.md): Offer different versions to Stable and Beta customers. - [Release Channels](https://docs.authlyx.dev/v3/guides/release-channels.md): Offer a test build to selected customers before the stable release. - [Allowed Versions](https://docs.authlyx.dev/v3/guides/allowed-versions.md): Choose which versions of your app may sign in. - [AppKeys and management keys](https://docs.authlyx.dev/v3/guides/app-credentials.md): AppKeys and management keys in AuthlyX, with examples and troubleshooting. - [Set up app hashes](https://docs.authlyx.dev/v3/guides/app-hashes.md): Allow approved application builds using SHA-256 hashes. - [Country and VPN restrictions](https://docs.authlyx.dev/v3/guides/network-policies.md): Country and VPN restrictions in AuthlyX, with examples and troubleshooting. - [Webhooks](https://docs.authlyx.dev/v3/guides/webhooks.md): Send app and account events from AuthlyX to your server. - [App logs and retention](https://docs.authlyx.dev/v3/guides/app-logs.md): App logs and retention in AuthlyX, with examples and troubleshooting. - [Fix connection and sign-in errors](https://docs.authlyx.dev/v3/guides/connection-errors.md): Fix connection and sign-in errors in AuthlyX, with examples and troubleshooting. - [Test your integration](https://docs.authlyx.dev/v3/guides/test-integration.md): Check successful sign-in, rejected access and session changes before sharing your app. - [Move from V2 to V3](https://docs.authlyx.dev/v3/api-reference/migration.md): Keep old clients working while testing V3. - [SDK downloads](https://docs.authlyx.dev/v3/sdks.md): Download AuthlyX SDK source by language. - [SDK versions and compatibility](https://docs.authlyx.dev/v3/sdks/methods/compatibility.md): See which languages and runtime versions the V3 Beta SDKs target. - [Initialize](https://docs.authlyx.dev/v3/sdks/methods/initialize.md): Start the SDK connection for one application. - [Results](https://docs.authlyx.dev/v3/sdks/methods/results.md): See what a result variable is and how each language reports success or failure. - [Login](https://docs.authlyx.dev/v3/sdks/methods/login.md): Sign in with a license, username and password, or an approved device. - [Register](https://docs.authlyx.dev/v3/sdks/methods/register.md): Create an app user using an unused license. - [Change password](https://docs.authlyx.dev/v3/sdks/methods/change-password.md): Change the password for the signed-in username account. - [Extend access](https://docs.authlyx.dev/v3/sdks/methods/extend-access.md): Apply an unused license to extend the signed-in user's access. - [Check session](https://docs.authlyx.dev/v3/sdks/methods/heartbeats.md): Check whether the current sign-in is still valid. - [Sign out](https://docs.authlyx.dev/v3/sdks/methods/sign-out.md): End the current session and clear the signed-in identity. - [Save offline access](https://docs.authlyx.dev/v3/sdks/methods/offline-access.md): Ask the SDK to store the server-approved offline permit. - [User Data](https://docs.authlyx.dev/v3/sdks/methods/user-data.md): Read the signed-in identity, its access details, and its plan features. - [Cloud variables](https://docs.authlyx.dev/v3/sdks/methods/cloud-variables.md): Read and update app values through the SDK. - [Fetch a script](https://docs.authlyx.dev/v3/sdks/methods/scripts.md): Fetch and verify a published script revision. - [Read and check features](https://docs.authlyx.dev/v3/sdks/methods/features.md): Read plan features and check whether one is enabled. - [Read and update metadata](https://docs.authlyx.dev/v3/sdks/methods/metadata.md): Read app-visible metadata and update fields that allow remote writes. - [Send an app log](https://docs.authlyx.dev/v3/sdks/methods/logs.md): Send a text log from the signed-in application. - [Send a webhook event](https://docs.authlyx.dev/v3/sdks/methods/webhooks.md): Send a named event and data through AuthlyX to a configured destination. - [Using the API](https://docs.authlyx.dev/v3/api-reference.md): Understand versions, HTTP methods and authentication before sending requests. - [Making requests](https://docs.authlyx.dev/v3/api-reference/request-formats.md): Where to send the input for every public AuthlyX endpoint. - [Request signing](https://docs.authlyx.dev/v3/api-reference/request-signing.md): How V3 binds sessions and requests to an installation. - [Errors and response messages](https://docs.authlyx.dev/v3/api-reference/errors.md): Handle failed requests without checking English text. - [Management keys and bots](https://docs.authlyx.dev/v3/api-reference/management-overview.md): Manage records from a trusted server. ## API Docs - [Initialize](https://docs.authlyx.dev/v3/api-reference/client/authentication/sign-in/initialize.md): Client API > Authentication > Sign-in - [Prepare sign-in](https://docs.authlyx.dev/v3/api-reference/client/authentication/sign-in/prepare-sign-in.md): Client API > Authentication > Sign-in - [Login](https://docs.authlyx.dev/v3/api-reference/client/authentication/sign-in/login.md): Client API > Authentication > Sign-in - [Register](https://docs.authlyx.dev/v3/api-reference/client/authentication/sign-in/register.md): Client API > Authentication > Sign-in - [Check session](https://docs.authlyx.dev/v3/api-reference/client/authentication/sessions/check-session.md): Client API > Authentication > Sessions - [Sign out](https://docs.authlyx.dev/v3/api-reference/client/authentication/sessions/sign-out.md): Client API > Authentication > Sessions - [Read a variable](https://docs.authlyx.dev/v3/api-reference/client/app-data/cloud-variables/read-a-variable.md): Client API > App Data > Cloud Variables - [Update a variable](https://docs.authlyx.dev/v3/api-reference/client/app-data/cloud-variables/update-a-variable.md): Client API > App Data > Cloud Variables - [Fetch a script](https://docs.authlyx.dev/v3/api-reference/client/app-data/scripts/fetch-a-script.md): Client API > App Data > Scripts - [Get all features](https://docs.authlyx.dev/v3/api-reference/client/app-data/features/get-all-features.md): Client API > App Data > Features - [Get feature value](https://docs.authlyx.dev/v3/api-reference/client/app-data/features/get-feature-value.md): Client API > App Data > Features - [Check feature](https://docs.authlyx.dev/v3/api-reference/client/app-data/features/check-feature.md): Client API > App Data > Features - [Get all metadata](https://docs.authlyx.dev/v3/api-reference/client/app-data/metadata/get-all-metadata.md): Client API > App Data > Metadata - [Get metadata value](https://docs.authlyx.dev/v3/api-reference/client/app-data/metadata/get-metadata-value.md): Client API > App Data > Metadata - [Update metadata](https://docs.authlyx.dev/v3/api-reference/client/app-data/metadata/update-metadata.md): Client API > App Data > Metadata - [Check metadata](https://docs.authlyx.dev/v3/api-reference/client/app-data/metadata/check-metadata.md): Client API > App Data > Metadata - [Send webhook](https://docs.authlyx.dev/v3/api-reference/client/app-data/webhooks/send-webhook.md): Client API > App Data > Webhooks - [Send log](https://docs.authlyx.dev/v3/api-reference/client/app-data/logs/send-log.md): Client API > App Data > Logs - [Prepare offline access](https://docs.authlyx.dev/v3/api-reference/client/offline-access/prepare-offline-access.md): Client API > Offline Access - [Get offline permit](https://docs.authlyx.dev/v3/api-reference/client/offline-access/get-offline-permit.md): Client API > Offline Access - [Change password](https://docs.authlyx.dev/v3/api-reference/client/account/change-password.md): Client API > Account - [Redeem license](https://docs.authlyx.dev/v3/api-reference/client/account/redeem-license.md): Client API > Account - [List applications](https://docs.authlyx.dev/v3/api-reference/management/applications/list-applications.md): Elite API > Applications - [Manage applications](https://docs.authlyx.dev/v3/api-reference/management/applications/manage-applications.md): Elite API > Applications - [List users](https://docs.authlyx.dev/v3/api-reference/management/users/list-users.md): Elite API > Users - [Manage users](https://docs.authlyx.dev/v3/api-reference/management/users/manage-users.md): Elite API > Users - [List licenses](https://docs.authlyx.dev/v3/api-reference/management/licenses/list-licenses.md): Elite API > Licenses - [Manage licenses](https://docs.authlyx.dev/v3/api-reference/management/licenses/manage-licenses.md): Elite API > Licenses - [List devices](https://docs.authlyx.dev/v3/api-reference/management/devices/list-devices.md): Elite API > Devices - [Manage devices](https://docs.authlyx.dev/v3/api-reference/management/devices/manage-devices.md): Elite API > Devices - [List plans](https://docs.authlyx.dev/v3/api-reference/management/plans/list-subscriptions.md): Elite API > Plans - [Manage plans](https://docs.authlyx.dev/v3/api-reference/management/plans/manage-subscriptions.md): Elite API > Plans - [List cloud variables](https://docs.authlyx.dev/v3/api-reference/management/cloud-variables/list-variables.md): Elite API > Cloud Variables - [Manage cloud variables](https://docs.authlyx.dev/v3/api-reference/management/cloud-variables/manage-variables.md): Elite API > Cloud Variables - [Run a bot command](https://docs.authlyx.dev/v3/api-reference/management/bots/bot-command.md): Elite API > Bots ## OpenAPI Specification - [OpenAPI JSON](https://docs.authlyx.dev/openapi.json): raw OpenAPI 3.1 specification for this API, JSON format - [OpenAPI YAML](https://docs.authlyx.dev/openapi.yaml): raw OpenAPI 3.1 specification for this API, YAML format