Sign in
Opens a session for a user who proves possession of the registered authorization key pair.
The signature is computed as follows:
- Take the BLAKE2b-256 digest of the email (UTF-8 bytes).
- Set the lowest bit of the last digest byte (
digest[31] |= 1). - Sign the 32 digest bytes with Ed25519, using the private key of the authorization key pair.
- Send the signature as hex.
When the user has the emailed one-time code turned on, the first call without authCode answers 428 with code 65 and a code is emailed. Repeat the call with the same body plus authCode. A code is valid for 5 minutes and works once. Another code can be emailed one minute after the last one; until then a call without authCode answers 428 with code 63. A call with authCode when no valid code exists also emails a fresh code and answers 428 with code 65.
When the method asked first for the user is an authenticator app or a passkey, the first call answers 428 with code 80. Its data is an object: methods lists the second steps the user has set up (passkey, totp, email), preferred names the one asked first, and passkey holds the options for a browser when the user has a passkey. Repeat the call with method and authCode:
method: totpwith the 6-digit code of the authenticator app. WithoutauthCodethe call answers 428 with code 63.method: emailto use the emailed code, when the user has it set up.- A passkey is answered by a browser and cannot be used by an API client. For an account that an integration signs in with, set up the emailed code or the authenticator app.
A method that is not set up for the user answers 409 with code 75.
Send email exactly as it was registered. Send authPublicKeyHex as lower-case hex without a prefix.
The answer carries the access token (valid 5 minutes) and the refresh token (valid 24 hours). A user who is registered but not yet approved can sign in, but can only read the own account and sign out. The tokens carry the state of the user at the time they were issued: after approval, the other routes open with the next token, from a refresh or a sign-in.
Request Body
Responses
The session tokens.