Password sign-in - Cloudreve API Docs

Request

Body Params application/json

captcha

string | null

optional

User input value of the graphical CAPTCHA. Required if graphic CAPTCHA enabled for current action.

Example:

z3ds

ticket

string | null

optional

Ticket/Token of the CAPTCHA. Required if CAPTCHA is enabled for current action. Can be obtained from Get CAPTCHA.

Example:

4qXv7KmbYajJ0yFDKcmJ

email

string

required

Email of the desired user.

Example:

user@cloudreve.org

password

string

required

Password of the desired user.

Example:

P@ssw0rd

Example

{
    "captcha": "z3ds",
    "ticket": "4qXv7KmbYajJ0yFDKcmJ",
    "email": "user@cloudreve.org",
    "password": "P@ssw0rd"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://localhost:5212/api/v4/session/token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "captcha": "z3ds",
    "ticket": "4qXv7KmbYajJ0yFDKcmJ",
    "email": "user@cloudreve.org",
    "password": "P@ssw0rd"
}'

Responses

🟢200Success

application/json

Body

data

#/definitions/176052892

required

Response content

code

integer

required

Response code.
0 - Success.

Default:

0

Example:

0

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

{
    "code": 0,
    "data": {
        "user": {
            "id": "lpua",
            "email": "admin@cloudreve.org",
            "nickname": "Aaron Liu2",
            "status": "active",
            "avatar": "file",
            "created_at": "2023-08-06T19:21:59+08:00",
            "credit": 23000,
            "group": {
                "id": "z4u4",
                "name": "管理员",
                "permission": "/f8B",
                "direct_link_batch_size": 999,
                "trash_retention": 604800
            },
            "pined": [
                {
                    "uri": "cloudreve://my/1"
                },
                {
                    "uri": "cloudreve://my/1/2"
                },
                {
                    "uri": "cloudreve://my/1/2/3/soft-delete"
                },
                {
                    "uri": "cloudreve://my/0/1/2/3/4/5/6/7/8/9/Q3%E5%A4%B4%E8%84%91%E9%A3%8E%E6%9A%B4"
                },
                {
                    "uri": "cloudreve://bnUn@my"
                }
            ],
            "language": "en-US"
        },
        "token": {
            "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwic3ViIjoibHB1YSIsImV4cCI6MTc0NTY1NTU3OCwibmJmIjoxNzQ1NjUxOTc4fQ.L1ETHHBNImNevze00QAgrrY1maZO2nefyIwdT4cb68c",
            "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsInN1YiI6ImxwdWEiLCJleHAiOjE3NjEyMDM5NzgsIm5iZiI6MTc0NTY1MTk3OCwic3RhdGVfaGFzaCI6Ikk1OCtSbmsrTHVpTkxBbjBqek9KNG45OUorV3hqL0pzbjJoRVYrUXBhelE9In0.Q2s75zxPVA3bzZyIIBau3TBvqSxIdzbiEmK1zCd-_zk",
            "access_expires": "2025-04-26T16:19:38.833494+08:00",
            "refresh_expires": "2025-10-23T15:19:38.833495+08:00"
        }
    },
    "msg": ""
}

🟢2002FA required