Skip to main content

FIDO2 registration options (also handles authentication)

POST 

/nevisfido/fido2/attestation/options

This endpoint implements the first step of the FIDO2/WebAuthn ceremony flow as defined by the W3C WebAuthn specification, where the server generates a cryptographic challenge and configuration options for the client before the authenticator is invoked. The client passes the returned options to the WebAuthn browser API, which prompts the user's platform or roaming authenticator to create or retrieve a credential. Once the authenticator has responded, the client submits its output to the corresponding result endpoint to complete the ceremony. This endpoint handles both registration and authentication in a single path — the ceremony type is determined automatically from the content of the request.

Request

Header Parameters

    headers objectrequired

Body

required

Registration request example

    displayName string
    extensions object
    appid string
    appidExclude string
    uvm boolean
    credProps boolean
    credentialProtectionPolicy string

    Possible values: [userVerificationOptional, userVerificationOptionalWithCredentialIDList, userVerificationRequired]

    enforceCredentialProtectionPolicy boolean
    hmacCreateSecret boolean
    hmacGetSecret object
    salt1 byte
    salt2 byte
    username string
    authenticatorSelection object
    authenticatorAttachment string
    requireResidentKey boolean
    residentKey string
    userVerification string
    attestation string

Responses

OK The server processed the request successfully. A ServerPublicKeyCredentialCreationOptionsResponse JSON object is returned.

Schema
    oneOf
    timeout int64
    rp object
    id string
    name string
    user object
    name string
    id string
    displayName string
    extensions object
    appid string
    appidExclude string
    uvm boolean
    credProps boolean
    credentialProtectionPolicy string

    Possible values: [userVerificationOptional, userVerificationOptionalWithCredentialIDList, userVerificationRequired]

    enforceCredentialProtectionPolicy boolean
    hmacCreateSecret boolean
    hmacGetSecret object
    salt1 byte
    salt2 byte
    authenticatorSelection object
    authenticatorAttachment string
    requireResidentKey boolean
    residentKey string
    userVerification string
    attestation string
    challenge string
    pubKeyCredParams object[]
  • Array [
  • type string
    alg int64
  • ]
  • excludeCredentials object[]
  • Array [
  • type string
    id string
    transports string[]
  • ]
  • status string

    Possible values: [ok, failed]

    errorMessage string
    fido2SessionId string
Loading...