Skip to main content
POST
Create a 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 configuration to create.

relyingParty
string
required

The relying party domain, without a URL scheme. Required for PASSKEY.

Minimum string length: 1
expectedOrigins
string[]
required

Allowed web or Android origins. Required for PASSKEY.

Minimum array length: 1
Minimum string length: 1
Pattern: ^(https?://|android:)
isActive
boolean

Whether the authentication method is active. Defaults to true.

passkeyRegistrationHints
enum<string>[]

Registration hints for PASSKEY.

Available options:
security-key,
client-device,
hybrid
userVerificationRequirement
enum<string>

The user verification requirement for PASSKEY.

Available options:
preferred,
required
authenticatorAttachment
enum<string>

The attachment preference for PASSKEY.

Available options:
cross-platform,
platform,
all-supported

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