Prepare login

GET

/session/prepare

Query if a given is existed, and all possible login method for it. This method is not required to perform a sign in, it just provide more context for frontent UI.

Request

Body Params application/json

string <email>

required

Account email.

Example:

example@cloudreve.org

Example

{
    "email": "example@cloudreve.org"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/session/prepare' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "example@cloudreve.org"
}'

Responses

🟢200Success

application/json

Body

data

object

required

Response content

webauthn_enabled

boolean

optional

Whether this account can be logged in with Passkeys.

sso_enabled

boolean

optional

Whether this account can be logged in with Logto.

password_enabled

boolean

required

Whether this account can be logged in with password.

qq_enabled

boolean

optional

Whether this account can be logged in with Tencent QQ.

code

integer

required

Response code.
0 - Success.

Default:

Example:

msg

string

optional

Human readable error message (if any).

error

string | null

optional

Internal error message, only visable in debug mode.

correlation_id

string <uuid> | null

optional

Correlation ID of the request. Only presented on failed reqeust.

Example:

b4351ecc-ee1a-4455-bc94-2c3dbcc58538

Example

{
    "data": {
        "webauthn_enabled": true,
        "sso_enabled": false,
        "password_enabled": true,
        "qq_enabled": true
    },
    "code": 0,
    "msg": ""
}

Modified at 2025-04-26 08:46:59

Finish Passkey sign-in

Prepare passkey registration