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

Define claims display description and claims path query #276

Merged
merged 27 commits into from
Dec 17, 2024
Merged

Define claims display description and claims path query #276

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
e47e3cf
Define claims display description and claims path query
danielfett Feb 20, 2024
2c25819
Fix claims parameter descriptions
danielfett Feb 20, 2024
bf614fc
Fix reference
danielfett Feb 20, 2024
ae77d25
Note on order of elements
danielfett Feb 20, 2024
5bb289f
Attempt to fix rendering
danielfett Feb 20, 2024
46f739f
Adapt examples
danielfett Feb 20, 2024
ba188d7
Update openid-4-verifiable-credential-issuance-1_0.md
danielfett Feb 23, 2024
3182f88
Merge main
danielfett Sep 12, 2024
1d04182
Fixes after merging main
danielfett Sep 12, 2024
b983e2b
Fix url/uri
danielfett Sep 12, 2024
8e37c65
Clarify processing rules
danielfett Sep 12, 2024
504514b
Merge branch 'main' into danielfett/fix-claims-in-issuer-metadata
danielfett Nov 19, 2024
8858254
Update openid-4-verifiable-credential-issuance-1_0.md
danielfett Nov 19, 2024
9c5961c
Merge branch 'main' into danielfett/fix-claims-in-issuer-metadata
danielfett Nov 22, 2024
4809b10
Start addressing todos before merging
danielfett Nov 26, 2024
1ca0100
Fix examples
danielfett Nov 26, 2024
e681e15
Fix rendering
danielfett Nov 26, 2024
2a6dcff
Move credentialSubject out of credential_definition and renamed it to…
danielfett Nov 27, 2024
7a254f8
Apply suggestions from WG review
Sakurann Nov 28, 2024
277e708
Fix mistake in examples
danielfett Dec 2, 2024
c47ad07
Apply suggestions from code review
danielfett Dec 10, 2024
04bd2d0
Use path for claims path pointer in mdoc
Dec 12, 2024
ecb1ee5
Minor fix
Dec 12, 2024
81f54c5
Merge branch 'main' into danielfett/fix-claims-in-issuer-metadata
Dec 12, 2024
cb81527
Remove value_type
danielfett Dec 12, 2024
b03a75b
fix example
Sakurann Dec 17, 2024
b656098
change wording
danielfett Dec 17, 2024
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
10 changes: 5 additions & 5 deletions examples/authorization_details_jwt_vc_json.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
"type": "openid_credential",
"credential_configuration_id": "UniversityDegreeCredential",
"credential_definition": {
"credentialSubject": {
"given_name": {},
"family_name": {},
"degree": {}
}
"credentialSubject": [
{"path": ["given_name"]},
{"path": ["family_name"]},
{"path": ["degree"]}
]
}
}
]
10 changes: 5 additions & 5 deletions examples/authorization_details_ldp_vc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
"type": "openid_credential",
"credential_configuration_id": "UniversityDegree_LDP_VC",
"credential_definition": {
"credentialSubject": {
"given_name": {},
"family_name": {},
"degree": {}
}
"credentialSubject": [
danielfett marked this conversation as resolved.
Show resolved Hide resolved
{"path": ["given_name"]},
{"path": ["family_name"]},
{"path": ["degree"]}
]
}
}
]
16 changes: 8 additions & 8 deletions examples/authorization_details_mso_doc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
"type":"openid_credential",
"credential_configuration_id": "org.iso.18013.5.1.mDL",
"claims": {
"org.iso.18013.5.1": {
"given_name": {},
"family_name": {},
"birth_date": {}
},
"org.iso.18013.5.1.aamva": {
"organ_donor": {}
}
"org.iso.18013.5.1": [
{"path": ["given_name"]},
{"path": ["family_name"]},
{"path": ["birth_date"]}
],
"org.iso.18013.5.1.aamva": [
{"path": ["organ_donor"]}
]
}
}
]
17 changes: 11 additions & 6 deletions examples/credential_issuer_metadata_jwt_vc_json.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,32 +38,37 @@
"VerifiableCredential",
"UniversityDegreeCredential"
],
"credentialSubject": {
"given_name": {
"credentialSubject": [
{
"path": ["given_name"],
"display": [
{
"name": "Given Name",
"locale": "en-US"
}
]
},
"family_name": {
{
"path": ["family_name"],
"display": [
{
"name": "Surname",
"locale": "en-US"
}
]
},
"degree": {},
"gpa": {
{
"path": ["degree"]
},
{
"path": ["gpa"],
"display": [
{
"name": "GPA"
}
]
}
}
]
},
"proof_types_supported": {
"jwt": {
Expand Down
17 changes: 11 additions & 6 deletions examples/credential_metadata_jwt_vc_json.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,38 @@
"VerifiableCredential",
"UniversityDegreeCredential"
],
"credentialSubject": {
"given_name": {
"credentialSubject": [
{
"path": ["given_name"],
"display": [
{
"name": "Given Name",
"locale": "en-US"
}
]
},
"family_name": {
{
"path": ["family_name"],
"display": [
{
"name": "Surname",
"locale": "en-US"
}
]
},
"degree": {},
"gpa": {
{
"path": ["degree"]
},
{
"path": ["gpa"],
"mandatory": true,
"display": [
{
"name": "GPA"
}
]
}
}
]
},
"proof_types_supported": {
"jwt": {
Expand Down
17 changes: 11 additions & 6 deletions examples/credential_metadata_ldp_vc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,33 +25,38 @@
"VerifiableCredential",
"UniversityDegreeCredential"
],
"credentialSubject": {
"given_name": {
"credentialSubject": [
{
"path": ["given_name"],
"display": [
{
"name": "Given Name",
"locale": "en-US"
}
]
},
"family_name": {
{
"path": ["family_name"],
"display": [
{
"name": "Surname",
"locale": "en-US"
}
]
},
"degree": {},
"gpa": {
{
"path": ["degree"]
},
{
"path": ["gpa"],
"mandatory": true,
"display": [
{
"name": "GPA"
}
]
}
}
]
},
"display": [
{
Expand Down
21 changes: 13 additions & 8 deletions examples/credential_metadata_mso_mdoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@
}
],
"claims": {
"org.iso.18013.5.1": {
"given_name": {
"org.iso.18013.5.1": [
{
"path": ["given_name"],
"display": [
{
"name": "Given Name",
Expand All @@ -45,21 +46,25 @@
}
]
},
"family_name": {
{
"path": ["family_name"],
"display": [
{
"name": "Surname",
"locale": "en-US"
}
]
},
"birth_date": {
{
"path": ["birth_date"],
"mandatory": true
}
},
"org.iso.18013.5.1.aamva": {
"organ_donor": {}
}
],
"org.iso.18013.5.1.aamva": [
{
"path": ["organ_donor"]
}
]
}
}
}
Expand Down
32 changes: 16 additions & 16 deletions examples/credential_metadata_sd_jwt_vc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@
}
],
"vct": "SD_JWT_VC_example_in_OpenID4VCI",
"claims": {
"given_name": {
"claims": [
{
"path": ["given_name"],
"display": [
{
"name": "Given Name",
Expand All @@ -31,7 +32,8 @@
}
]
},
"family_name": {
{
"path": ["family_name"],
"display": [
{
"name": "Surname",
Expand All @@ -43,19 +45,17 @@
}
]
},
"email": {},
"phone_number": {},
"address": {
"street_address": {},
"locality": {},
"region": {},
"country": {}
},
"birthdate": {},
"is_over_18": {},
"is_over_21": {},
"is_over_65": {}
}
{"path": ["email"]},
{"path": ["phone_number"]},
{"path": ["address", "street_address"]},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We would like to give display properties to an object of claims. The wallet could use this property when collapsing the object's claims in the UI. Is this possible and would the following be the right way?
If so, this should be part of an example.

                  {
                    "path": ["address"],
                    "display": [
                        {
                            "name": "Address",
                            "locale": "en-US"
                        },
                        {
                            "name": "Adresse",
                            "locale": "de-DE"
                        }
                    ],
                    "value_type": "object"
                },
                {"path": ["address", "street_address"]},

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for this! I think supporting this is mandatory for having a clear and defined way to present this kind of data to the user. Let's use the example from your documentation and extend it with an arbitrary example:

... 
"address": {
    "street_address": "42 Market Street",
    "city": "Milliways",
    "postal_code": "12345"
},
...
"work_address":  {
   "city": "Berlin",
  ...
},

I would expect/imagine this to be displayed in the ui similar to this:

place of residence
+- street: 42 Market Street
+- city: Milliways
`- post code: 12345
....
place of work
+- city: Berlin
+...

{"path": ["address", "locality"]},
{"path": ["address", "region"]},
{"path": ["address", "country"]},
{"path": ["birthdate"]},
{"path": ["is_over_18"]},
{"path": ["is_over_21"]},
{"path": ["is_over_65"]}
]
}
}
}
16 changes: 8 additions & 8 deletions examples/credential_request_iso_mdl_with_claims.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
"format": "mso_mdoc",
"doctype": "org.iso.18013.5.1.mDL",
"claims": {
"org.iso.18013.5.1": {
"given_name": {},
"family_name": {},
"birth_date": {}
},
"org.iso.18013.5.1.aamva": {
"organ_donor": {}
}
"org.iso.18013.5.1": [
{"path": ["given_name"]},
{"path": ["family_name"]},
{"path": ["birth_date"]}
],
"org.iso.18013.5.1.aamva": [
{"path": ["organ_donor"]}
]
},
"proof": {
"proof_type": "jwt",
Expand Down
8 changes: 3 additions & 5 deletions examples/credential_request_jwt_vc_json-ld.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@
"VerifiableCredential",
"UniversityDegreeCredential"
],
"credentialSubject":{
"degree":{
"type":{}
}
}
"credentialSubject":[
{"path": ["degree", "type"]}
]
},
"proof": {
"proof_type": "jwt",
Expand Down
10 changes: 5 additions & 5 deletions examples/credential_request_jwt_vc_json_with_claims.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
"VerifiableCredential",
"UniversityDegreeCredential"
],
"credentialSubject": {
"given_name": {},
"family_name": {},
"degree": {}
}
"credentialSubject": [
{"path": ["given_name"]},
{"path": ["family_name"]},
{"path": ["degree"]}
]
},
"proof": {
"proof_type": "jwt",
Expand Down
8 changes: 3 additions & 5 deletions examples/credential_request_ldp_vc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@
"VerifiableCredential",
"UniversityDegreeCredential"
],
"credentialSubject": {
"degree": {
"type": {}
}
}
"credentialSubject": [
{"path": ["degree", "type"]}
]
},
"proof": {
"proof_type": "jwt",
Expand Down
8 changes: 3 additions & 5 deletions examples/credential_request_ldp_vc_vp.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@
"VerifiableCredential",
"UniversityDegreeCredential"
],
"credentialSubject": {
"degree": {
"type": {}
}
}
"credentialSubject": [
{"path": ["degree", "type"]}
]
},
"proof": {
"proof_type": "ldp_vp",
Expand Down
Loading
Loading