Prepare OpenID sign-in - Cloudreve API Docs

Preapre a social connector sign in, can be used to sign in Cloudreve account, or link existing account with a social connector account.

For signing in with social connector, authorization is not required.

For account linking, authorization is required for a valid logged-in user.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Body Params application/json

hint

string <email> | null

optional

Email of preferred 3rd party account. Only Logto supports it.

linking

boolean | null

optional

Whether this sign in is for linking existing account in Cloudreve. If true, a valid session is required.

provider

enum<integer>

optional

OpenID provider type ID.

Allowed values:

012

Example

{
    "hint": "user@example.com",
    "linking": true,
    "provider": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

string <uri>

required

Redirect URL for the 3rd party sign in.

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

{
    "code": 0,
    "data": "https://kqyhaj.logto.app/oidc/auth?client_id=negu9t0i5imx005vfd9hs&code_challenge=tWQ6Q2M4Ejkt9gwURhyBVxrtT7gfnbxe59ia-J8NuuE&code_challenge_method=S256&prompt=consent&redirect_uri=http://127.0.0.1:5212/callback/openid/0&response_type=code&scope=openid offline_access profile email&state=fbc710af-6a46-49e9-9a0c-59123163f941",
    "msg": ""
}