OpenID4VCI icon indicating copy to clipboard operation
OpenID4VCI copied to clipboard

Interpretation of issuer metadata `display` parameters

Open nemqe opened this issue 1 year ago • 4 comments

Is there a explanation how the display parameters from the issuer metadata need to be interpreted by the wallet.

I would like to answer some questions like:

  • is display a hint or a requirement for the wallet
  • what should wallet display if the metadata contains no display properties on any level
  • does a missing display property on a credential_configuration level signal that no claims should be shown on the wallet for a particular credential
  • does a missing display property on a claim level signal that the claim in question should be hidden
  • what happens if a specific locale is specified one the credential_configuration level but that locale cannot be found on the claim level
  • ...

Seems this part is a tad under-specified, maybe it is by design for now or maybe I am missing another source of information on this topic.

nemqe avatar Aug 15 '24 15:08 nemqe

responding to each of the points (numbering them, so that it is easy to continue the discussion:

  1. i think the intention is for display to be a requirement for the wallet. it is a very important for issuer branding that wallet uses logo, colors, etc as requested by the issuer
  2. if there is no display properties on any level, there is nothing for the wallet to display, so those fields should be empty, no logo, no color, etc.
  3. credential_configuration level display property is for the entire credential, so per point 2. that would mean that credential is displayed but with no display information
  4. claim level display property is for that claim, so per point 2-3. that would mean that claim is displayed but with no display information
  5. what happens if a specific locale is specified one the credential_configuration level but that locale cannot be found on the claim level

i agree a non-normative clarification on these would be helpful

Sakurann avatar Aug 20 '24 11:08 Sakurann

Thank you for the answer!

Just to repeat to see if my understanding is correct here.

When you say display information we are talking about information carried in the display property for a given level, but that display information is only used to enrich the way how the credential is displayed (style, locale) but it is not used as a signal that certain parts of a credential should not be shown by the wallet.

If I as an issuer would issue a credential without having any display properties in my metadata the wallet should not interpret that as :

  • "Display is missing I do not know what to display so I won't display anything"

but it should interpret it as

  • "Display is missing so I have no requirements on how to style or localize this credential so I should display it using default colors and fonts and locale per my wallet settings"?

If for some of the levels there are display properties we use those and for other we just do the default.

Sorry for potentially silly questions, but we had some discussions lately in the space where people were using for example presence of the claims level display property as a signal that the claim in question should not be displayed to the user at all (akin to css visibility type hidden), so I am just trying to get a baseline of understanding on my end so I know what I need to implement on the issuer side of things.

nemqe avatar Aug 20 '24 12:08 nemqe

Hello To complete, on our side as a wallet provider it seems not possible for us to decide if an attribute should or should not be displayed to the user. Some VCs carry information that does not make sense to the user and therefore it seems normal that the issuer does not want to display them. So until today the wallet displays the claims that have a "display" attribute and only those that have the attribute. So it is not just a "style" problem.

ThierryThevenet avatar Aug 26 '24 09:08 ThierryThevenet

ah, thank you for clarification, i understand the question better now. i think we need to discuss in the WG what is the behavior when the display information is missing. i am not sure "wallet should display credential using default colors and fonts and locale per wallet settings" is ideal. maybe that means display for the credentials needs to be mandatory... unless vct...

Sakurann avatar May 19 '25 23:05 Sakurann

WG discussion:

  • it is already a should (that is very close to a must in reality) for the wallet to follow the credential display in the issuer metadata, so when the credential display is not provided, it is also up to the wallet to decide what to do.

action: change should in this sentence to clarify it is not normative

A claims description object as used in the Credential Issuer metadata is an object used to describe how a certain claim in the Credential should be displayed to the End-User.

Sakurann avatar May 20 '25 19:05 Sakurann