Struct passkey_types::webauthn::PublicKeyCredentialUserEntity

pub struct PublicKeyCredentialUserEntity {
    pub id: Bytes,
    pub display_name: String,
    pub name: String,
}

This type is used to supply additional user account attributes when creating a new credential.

The name and display_name members should follow the following guidelines:

• Relying Parties SHOULD perform enforcement, as prescribed in Section 2.3 of RFC8266 for the Nickname Profile of the PRECIS FreeformClass RFC8264, when setting name’s value, or displaying the value to the user.
• This string MAY contain language and direction metadata. Relying Parties SHOULD consider providing this information. See Language and Direction Encoding about how this metadata is encoded.
• Clients SHOULD perform enforcement, as prescribed in Section 2.3 of RFC8266 for the Nickname Profile of the PRECIS FreeformClass RFC8264, on name’s value prior to displaying the value to the user or including the value as a parameter of the authenticatorMakeCredential operation.

https://w3c.github.io/webauthn/#dictdef-publickeycredentialuserentity

Fields

id: Bytes

The user handle of the user account. A user handle is an opaque byte sequence with a maximum size of 64 bytes, and is not meant to be displayed to the user.

To ensure secure operation, authentication and authorization decisions MUST be made on the basis of this id member, not the Self::display_name nor Self::name members.

The user handle MUST NOT contain personally identifying information about the user, such as a username or e-mail address; see User Handle Contents for details. The user handle MUST NOT be empty.

display_name: String

A human-palatable name for the user account, intended only for display. For example:

• “Alex Müller” or
• “田中倫”.

The Relying Party SHOULD let the user choose this, and SHOULD NOT restrict the choice more than necessary.

Authenticators MUST accept and store a 64-byte minimum length for a display_name member’s value. Authenticators MAY truncate a displayName member’s value so that it fits within 64 bytes. See String Truncation about truncation and other considerations.

name: String

A 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 Self::display_names. For example:

• “alexm”,
• “alex.mueller@example.com” or
• “+14255551234”

Authenticators MUST accept and store a 64-byte minimum length for a display_name member’s value. Authenticators MAY truncate a displayName member’s value so that it fits within 64 bytes. See String Truncation about truncation and other considerations.

Trait Implementations

impl Clone for PublicKeyCredentialUserEntity

fn clone(&self) -> PublicKeyCredentialUserEntity

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PublicKeyCredentialUserEntity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PublicKeyCredentialUserEntity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PublicKeyCredentialUserEntity> for PublicKeyCredentialUserEntity

fn from(value: PublicKeyCredentialUserEntity) -> Self

Converts to this type from the input type.

impl Serialize for PublicKeyCredentialUserEntity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PublicKeyCredentialUserEntity> for PublicKeyCredentialUserEntity

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: PublicKeyCredentialUserEntity) -> Result<Self, Self::Error>

Performs the conversion.