Finish OpenID sign-in - Cloudreve API Docs

Request

Body Params application/json

code

string

required

OAuth code, can be found in the redirected URL query string after user sign in complete.

Example:

uGPCFrT0hZYy4PfLloRyHhvejdkma95l

session_id

string <uuid>

required

Sign in session ID, can be found in the redirected URL query string state.

Example:

1728791b-4e6a-4ac5-adf5-fa717a6b0919

provider_id

integer

required

OpenID provider type ID.

Example:

0

Example

{
    "code": "uGPCFrT0hZYy4PfLloRyHhvejdkma95l",
    "session_id": "1728791b-4e6a-4ac5-adf5-fa717a6b0919",
    "provider_id": 0
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/session/openid' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "uGPCFrT0hZYy4PfLloRyHhvejdkma95l",
    "session_id": "1728791b-4e6a-4ac5-adf5-fa717a6b0919",
    "provider_id": 0
}'

Responses

🟢200Success - Sign in account

application/json

Body

data

object (LoginResponse)

required

user

object (User)

required

token

object (Token)

required

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

{
    "data": {
        "user": {
            "id": "6JIo",
            "email": "Cassidy.Hagenes@gmail.com",
            "nickname": "Johnny Zhang",
            "created_at": "2023-08-06T19:21:59+08:00",
            "anonymous": true,
            "group": {
                "id": "1AI8",
                "name": "Admin",
                "permission": "/f8B",
                "direct_link_batch_size": 10,
                "trash_retention": 864000
            },
            "status": "active",
            "avatar": "file",
            "preferred_theme": "#131313",
            "credit": 98,
            "language": "en-US"
        },
        "token": {
            "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwic3ViIjoibHB1YSIsImV4cCI6MTc0NTY1NDMwOCwibmJmIjoxNzQ1NjUwNzA4fQ.n2z8AY-A9GC-CymOsLSA8ruV3vYgNJd27MXRcm4bVu8",
            "access_expires": "2025-04-26T15:58:28.456762+08:00",
            "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsInN1YiI6ImxwdWEiLCJleHAiOjE3NjEyMDI3MDgsIm5iZiI6MTc0NTY1MDcwOCwic3RhdGVfaGFzaCI6Ikk1OCtSbmsrTHVpTkxBbjBqek9KNG45OUorV3hqL0pzbjJoRVYrUXBhelE9In0.KoechX6_A2NeVcfFAlHkRLk572hjPKepP0XWfbvBxZY",
            "refresh_expires": "2025-10-23T14:58:28.456762+08:00"
        }
    },
    "code": 0,
    "msg": ""
}

🟢200Success - Link existing account