From 0d9b6bdbd9cd70a2327561cf6f5386ff9e703a83 Mon Sep 17 00:00:00 2001 From: briskt <3172830+briskt@users.noreply.github.com> Date: Tue, 19 Nov 2024 16:13:24 +0800 Subject: [PATCH] fix README errors and omissions --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a90619b..aba1dc7 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ to the WebAuthn library and fit the structures it was expecting without causing ### Required Headers 1. `x-mfa-apikey` - The API Key 2. `x-mfa-apisecret` - The API Key Secret -3. `x-mfa-RPDisplayName` - The Relay Party Display Name, ex: `ACME Inc.` -4. `x-mfa-RPID` - The Relay Party ID, ex: `domain.com` (should only be the top level domain, no subdomain, protocol, +3. `x-mfa-RPDisplayName` - The Relying Party Display Name, ex: `ACME Inc.` +4. `x-mfa-RPID` - The Relying Party ID, ex: `domain.com` (should only be the top level domain, no subdomain, protocol, or path) 5. `x-mfa-RPOrigin` - The browser Origin for the request, ex: `https://sub.domain.com` (include appropriate subdomain and protocol, no path or port) @@ -30,6 +30,11 @@ to do with WebAuthn, but is the primary key for finding the right records in Dyn 7. `x-mfa-Username` - The user's username of your service 8. `x-mfa-UserDisplayName` - The user's display name +### Optional headers + +1. `x-mfa-Usericon` - +2. `x-mfa-Rpicon` - + ### Begin Registration `POST /webauthn/register`