Prepare passkey registration

Prepare to register a new passkey.

Add the parameter

Authorization

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

Example:

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

Responses

🟢200Success

application/json

Body

data

object

optional

Response content. In some error type, e.g. lock conflicting errors, this field wil present details of the error, e.g. who is locking the current file.

publicKey

object

required

A PublicKeyCredentialCreationOptions object that can be used to invoke passkey registration from browser.

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": {
        "publicKey": {
            "rp": {
                "name": "Cloudreve",
                "id": "localhost"
            },
            "user": {
                "name": "luke@skywalker.com",
                "displayName": "Luke Skywalker",
                "id": "Ym5Vbg"
            },
            "challenge": "TSMn9HYi5vCJasIbJYRwEgf4nHVzHU_ldZUzeySb5Uk",
            "pubKeyCredParams": [
                {
                    "type": "public-key",
                    "alg": -7
                },
                {
                    "type": "public-key",
                    "alg": -35
                },
                {
                    "type": "public-key",
                    "alg": -36
                },
                {
                    "type": "public-key",
                    "alg": -257
                },
                {
                    "type": "public-key",
                    "alg": -258
                },
                {
                    "type": "public-key",
                    "alg": -259
                },
                {
                    "type": "public-key",
                    "alg": -37
                },
                {
                    "type": "public-key",
                    "alg": -38
                },
                {
                    "type": "public-key",
                    "alg": -39
                },
                {
                    "type": "public-key",
                    "alg": -8
                }
            ],
            "timeout": 300000,
            "excludeCredentials": [
                {
                    "type": "public-key",
                    "id": "-l161nXQn7juNPvQ8dlkbQ"
                }
            ],
            "authenticatorSelection": {
                "requireResidentKey": true,
                "userVerification": "preferred"
            }
        }
    },
    "msg": ""
}

Request

Request samples

Responses