Passkeys

Used to interact with the passkeys of the logged in user.

Create Passkey

Create a new passkey.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
_clerk_session_id
string

The session_id associated with the requesting user.

header Parameters
Origin
string

The origin of the request.

X-Original-Host
string

The original host of the request.

Responses
200

Returns the response for Session wrapped Passkey object.

403

Request was not successful

post/v1/me/passkeys
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Get Passkey

Retrieve all properties associated a specific passkey.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
passkey_id
required
string

The passkey identification ID.

Responses
200

Returns the response for Session wrapped Passkey object.

404

Request was not successful

422

Request was not successful

get/v1/me/passkeys/{passkey_id}
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Update Passkey

Update properties of a specific passkey.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
passkey_id
required
string

The passkey identification ID.

Request Body schema: application/x-www-form-urlencoded
name
string or null

The name of the passkey.

Responses
200

Returns the response for Session wrapped Passkey object.

404

Request was not successful

422

Request was not successful

patch/v1/me/passkeys/{passkey_id}
Request samples
application/x-www-form-urlencoded
name=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Delete Passkey

Delete a passkey by id.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
passkey_id
required
string

The passkey identification ID.

Responses
200

Returns a deleted Passkey object.

403

Request was not successful

404

Request was not successful

delete/v1/me/passkeys/{passkey_id}
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Attempt Passkey Verification

Attempts to verify the provided passkey.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
passkey_id
required
string

The passkey identification ID.

header Parameters
Origin
string

The origin of the request.

Request Body schema: application/x-www-form-urlencoded
strategy
string or null

The strategy used to connect the external account.

Value: "passkey"
public_key_credential
string or null

The public key credential of the passkey.

Responses
200

Returns the response for Session wrapped Passkey object.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/me/passkeys/{passkey_id}/attempt_verification
Request samples
application/x-www-form-urlencoded
strategy=passkey&public_key_credential=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}