Skip to main content
PATCH
Update the passkey configuration

Authorizations

Authorization
string
header
required

Use your Authsignal Management API secret key as the username and leave the password empty. This key is different from the Server API key and can be found in the API Keys section of the Authsignal Portal settings page.

Body

application/json

Passkey fields to update. Omitted fields are preserved. Send null for a clearable field to remove it.

isActive
boolean
relyingParty
string

The relying party domain, without a URL scheme.

Minimum string length: 1
expectedOrigins
string[]

Allowed web or Android origins.

Minimum array length: 1
Minimum string length: 1
Pattern: ^(https?://|android:)
passkeyRegistrationHints
enum<string>[]
Available options:
security-key,
client-device,
hybrid
userVerificationRequirement
enum<string> | null
Available options:
preferred,
required,
null
authenticatorAttachment
enum<string> | null
Available options:
cross-platform,
platform,
all-supported,
null

Response

OK

authenticatorId
string
required
read-only

The immutable identifier for this configuration.

isActive
boolean
required
verificationMethod
string
required
read-only

The verification method produced by this configuration.

Allowed value: "PASSKEY"
relyingParty
string
expectedOrigins
string[]
passkeyRegistrationHints
enum<string>[]
Available options:
security-key,
client-device,
hybrid
userVerificationRequirement
string | null
authenticatorAttachment
enum<string> | null
Available options:
cross-platform,
platform,
all-supported,
null