passkeyGenerateAuthenticateOptions

GET

/passkey/generate-authenticate-options

curl --request GET \
  --url https://gymgym.club/api/auth/passkey/generate-authenticate-options \
  --header 'Authorization: Bearer <token>'

Generate authentication options for a passkey

Authorizations

• bearerAuth

Responses

200

Success

Media typeapplication/json

object

challenge

string

rp

object

name

string

id

string

user

object

id

string

name

string

displayName

string

timeout

number

allowCredentials

Array<object>

object

id

string

type

string

transports

Array<string>

userVerification

string

authenticatorSelection

object

authenticatorAttachment

string

requireResidentKey

boolean

userVerification

string

extensions

object

Example^generated

{
  "challenge": "example",
  "rp": {
    "name": "example",
    "id": "example"
  },
  "user": {
    "id": "example",
    "name": "example",
    "displayName": "example"
  },
  "timeout": 1,
  "allowCredentials": [
    {
      "id": "example",
      "type": "example",
      "transports": [
        "example"
      ]
    }
  ],
  "userVerification": "example",
  "authenticatorSelection": {
    "authenticatorAttachment": "example",
    "requireResidentKey": true,
    "userVerification": "example"
  },
  "extensions": {}
}

400

Bad Request. Usually due to missing parameters, or invalid parameters.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

401

Unauthorized. Due to missing or invalid authentication.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Forbidden. You do not have permission to access this resource or to perform this action.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

404

Not Found. The requested resource was not found.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

429

Too Many Requests. You have exceeded the rate limit. Try again later.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

Internal Server Error. This is a problem with the server that you cannot fix.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}