From f911218be877ee47685602b8055b211ee6a503e6 Mon Sep 17 00:00:00 2001 From: Tim Cappalli Date: Wed, 21 Aug 2024 12:21:56 -0600 Subject: [PATCH] s/PublicKeyCredentialHints/PublicKeyCredentialHint --- index.bs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/index.bs b/index.bs index dd18bed90..2d569364f 100644 --- a/index.bs +++ b/index.bs @@ -3269,7 +3269,7 @@ optionally evidence of [=user consent=] to a specific transaction. See [[#dictionary-authenticatorSelection]]. : hints - :: This OPTIONAL member contains zero or more elements from {{PublicKeyCredentialHints}} to guide the user agent in interacting with the user. Note that the elements have type `DOMString` despite being taken from that enumeration. See [[#sct-domstring-backwards-compatibility]]. + :: This OPTIONAL member contains zero or more elements from {{PublicKeyCredentialHint}} to guide the user agent in interacting with the user. Note that the elements have type `DOMString` despite being taken from that enumeration. See [[#sct-domstring-backwards-compatibility]]. : attestation :: The [=[RP]=] MAY use this OPTIONAL member to specify a preference regarding [=attestation conveyance=]. @@ -3666,7 +3666,7 @@ an assertion. Its {{PublicKeyCredentialRequestOptions/challenge}} member MUST be See {{UserVerificationRequirement}} for the description of {{AuthenticatorSelectionCriteria/userVerification}}'s values and semantics. : hints - :: This OPTIONAL member contains zero or more elements from {{PublicKeyCredentialHints}} to guide the user agent in interacting with the user. Note that the elements have type `DOMString` despite being taken from that enumeration. See [[#sct-domstring-backwards-compatibility]]. + :: This OPTIONAL member contains zero or more elements from {{PublicKeyCredentialHint}} to guide the user agent in interacting with the user. Note that the elements have type `DOMString` despite being taken from that enumeration. See [[#sct-domstring-backwards-compatibility]]. : extensions :: The [=[RP]=] MAY use this OPTIONAL member to provide [=client extension inputs=] @@ -4161,19 +4161,19 @@ Note: The {{ClientCapability}} enumeration is deliberately not referenced, see [ :: The [=WebAuthn Client=] supports [[#sctn-related-origins|Related Origin Requests]]. -### User-agent Hints Enumeration (enum PublicKeyCredentialHints) ### {#enum-hints} +### User-agent Hints Enumeration (enum PublicKeyCredentialHint) ### {#enum-hints} - enum PublicKeyCredentialHints { + enum PublicKeyCredentialHint { "security-key", "client-device", "hybrid", }; -Note: The {{PublicKeyCredentialHints}} enumeration is deliberately not referenced, see [[#sct-domstring-backwards-compatibility]]. +Note: The {{PublicKeyCredentialHint}} enumeration is deliberately not referenced, see [[#sct-domstring-backwards-compatibility]]. -
+
[=[WRPS]=] may use this enumeration to communicate hints to the user-agent about how a request may be best completed. These hints are not requirements, and do not bind the user-agent, but may guide it in providing the best experience by using contextual information that the [=[RP]=] has about the request. Hints are provided in order of decreasing preference so, if two hints are contradictory, the first one controls. Hints may also overlap: if a more-specific hint is defined a [=[RP]=] may still wish to send less specific ones for user-agents that may not recognise the more specific one. In this case the most specific hint should be sent before the less-specific ones. Hints MAY contradict information contained in credential {{PublicKeyCredentialDescriptor/transports}} and {{AuthenticatorSelectionCriteria/authenticatorAttachment}}. When this occurs, the hints take precedence. (Note that {{PublicKeyCredentialDescriptor/transports}} values are not provided when using [=discoverable credentials=], leaving hints as the only avenue for expressing some aspects of such a request.)