Skip to navigation

Register

Creates an app user with a username, password and unused license. Prepare sign-in first and sign the register operation. This is not AuthlyX dashboard registration.

Headers

X-AuthlyX-NoncestringOptional
Random nonce for binding and verifying the signed response.

Request

This endpoint expects an object.
appKeystringRequired
Application identifier copied from the dashboard. Not an Elite Key or Bot Key.
versionstringRequired
Version of the application making this request, for example 1.0.0.
sidstringRequired
Stable platform system identifier. Windows SDK defaults use the Windows user SID.
challengeIdstringRequired

ID from an unexpired single-use challenge for this operation.

signaturestringRequired
Base64 Ed25519 signature over the challenge proof payload.
typeenumRequiredDefaults to register
Allowed values:
hashstringOptional

SHA-256 build hash. Required by policy when hash checking is enabled.

usernamestringOptional

App username, required for user and register sign-in. Between 1 and 200 characters.

passwordstringOptional

App password, required for user and register sign-in. Between 1 and 256 characters.

licenseKeystringOptional

License key belonging to this app. Required for license sign-in and registration.

installationPublicKeystringOptional

PEM-encoded Ed25519 public key for this installation. Never send its private key.

emailstringOptionalformat: "email"

Optional app-user email for registration.

Response

Successful
successboolean
codestring
messagestring
dataobject or null
requestIdstringformat: "uuid"
verificationobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
415
Unsupported Media Type Error
429
Too Many Requests Error
503
Service Unavailable Error