generatePasskeyRegistrationOptions

GET

/passkey/generate-register-options

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

Generate registration options for a new passkey

Authorizations

• bearerAuth

Parameters

Query Parameters

authenticatorAttachment

string

Allowed values: platform cross-platform

Type of authenticator to use for registration. “platform” for device-specific authenticators, “cross-platform” for authenticators that can be used across devices.

name

string

Optional custom name for the passkey. This can help identify the passkey when managing multiple credentials.

context

string

Optional context for passkey-first registration flows.

Responses

200

Success

Media typeapplication/json

object

challenge

string

rp

object

name

string

id

string

user

object

id

string

name

string

displayName

string

pubKeyCredParams

Array<object>

object

type

string

alg

number

timeout

number

excludeCredentials

Array<object>

object

id

string

type

string

transports

Array<string>

authenticatorSelection

object

authenticatorAttachment

string

requireResidentKey

boolean

userVerification

string

attestation

string

extensions

object

Example^generated

{
  "challenge": "example",
  "rp": {
    "name": "example",
    "id": "example"
  },
  "user": {
    "id": "example",
    "name": "example",
    "displayName": "example"
  },
  "pubKeyCredParams": [
    {
      "type": "example",
      "alg": 1
    }
  ],
  "timeout": 1,
  "excludeCredentials": [
    {
      "id": "example",
      "type": "example",
      "transports": [
        "example"
      ]
    }
  ],
  "authenticatorSelection": {
    "authenticatorAttachment": "example",
    "requireResidentKey": true,
    "userVerification": "example"
  },
  "attestation": "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"
}