Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify distinction between PublicKeyCredentialUserEntity name and displayName #1932

Merged
merged 10 commits into from
Sep 12, 2023
Merged

Clarify distinction between PublicKeyCredentialUserEntity name and displayName #1932

Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ec9dd1b
Emphasize user.name as primary identifier
MasterKale Jul 26, 2023
a87aa30
Define intended use case for displayName
MasterKale Jul 26, 2023
f09e3d8
Clarify that displayName can be the same as name
MasterKale Aug 1, 2023
c24ac18
Trim line length
MasterKale Aug 1, 2023
ea22418
Fix line length for `name`
MasterKale Aug 2, 2023
074be7f
Tweak `displayName` based on feedback
MasterKale Aug 2, 2023
03937f4
Try to tweak wording to emphasize name
MasterKale Aug 15, 2023
6b9a840
Suggest empty string for displayName when needed
MasterKale Aug 24, 2023
7068cfa
Streamline user.name definition and add examples
MasterKale Aug 24, 2023
aefe8f2
Tweak examples based on feedback
MasterKale Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3184,8 +3184,8 @@ associated with or [=scoped=] to, respectively.
including the value as a parameter of the [=authenticatorMakeCredential=] operation.

- When inherited by {{PublicKeyCredentialUserEntity}}, it is a [=human palatability|human-palatable=] identifier for a
[=user account=]. It is intended only for display, i.e., aiding the user in determining the difference between user
accounts with similar {{PublicKeyCredentialUserEntity/displayName}}s. For example, "alexm", "[email protected]"
[=user account=]. This identifier is the primary value displayed to users by [=Clients=] to help users understand with which
[=user account=] a credential is associated. Examples of suitable values for this identifier include, "alexm", "[email protected]"
or "+14255551234".

- The [=[RP]=] MAY let the user choose this value. The [=[RP]=] SHOULD perform enforcement,
Expand Down Expand Up @@ -3254,8 +3254,15 @@ credential.
with more than one [=user account=] at the [=[RP]=].

: <dfn>displayName</dfn>
:: A [=human palatability|human-palatable=] name for the [=user account=], intended only for display. For example, "Alex Müller" or "田中倫". The
[=[RP]=] SHOULD let the user choose this, and SHOULD NOT restrict the choice more than necessary.
:: A [=human palatability|human-palatable=] name for the [=user account=], intended only for display.
[=Clients=] may display this value to help users differentiate between multiple sub-accounts for a
given [=user account=] for situations in which every credential uses the same value for
{{PublicKeyCredentialEntity/name}}. When such differentiation is not required, this value
MAY be set to the same value as {{PublicKeyCredentialEntity/name}}. Examples of suitable
values for this identifier include, "Alex Müller" or "田中倫".

A [=[RP]=] MAY let the user specify this value, and SHOULD NOT restrict the choice
more than necessary when doing so.
emlun marked this conversation as resolved.
Show resolved Hide resolved

- [=[RPS]=] SHOULD perform enforcement, as prescribed in Section 2.3 of
[[!RFC8266]] for the Nickname Profile of the PRECIS FreeformClass [[!RFC8264]],
Expand Down