Skip to navigation

Prepare sign-in

Creates a single-use login challenge for an Ed25519 installation public key. Challenges expire after two minutes. Sign the exact challenge payload together with the normalized login operation; the SDK handles this.

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.
installationPublicKeystringRequired

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

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