Common Credential to OIDC Claim Mappings

Introduction

As described in the guide to Set up an OIDC Credential Verifier, claims from JSON-LD terms in the Credential need to be mapped to OIDC Claims used in the ID Token.

Common terms

Below is a list of the standard OIDC claims and their JSON-LD equivalent terms from https://schema.org.

These mappings can be pasted into the payload when setting up an OIDC Credential Verifier.

json
Copy to clipboard.
1 "claimMappings": [
2
3    {
4
5            "jsonLdFqn": "http://schema.org/givenName",
6
7            "oidcClaim": "given_name"
8
9
10
11
12    },
13
14    {
15
16            "jsonLdFqn": "http://schema.org/familyName",
17
18            "oidcClaim": "family_name"
19
20
21
22
23        },
24
25    {
26
27            "jsonLdFqn": "http://schema.org/name",
28
29            "oidcClaim": "name"
30
31
32
33
34        },
35
36    {
37
38            "jsonLdFqn": "http://schema.org/alternateName",
39
40            "oidcClaim": "nickname"
41
42
43
44
45        },
46
47    {
48
49            "jsonLdFqn": "http://schema.org/image",
50
51            "oidcClaim": "picture"
52
53        },
54
55    {
56
57            "jsonLdFqn": "http://schema.org/mainEntityOfPage",
58
59            "oidcClaim": "profile"
60
61        },
62
63    {
64
65            "jsonLdFqn": "http://schema.org/email",
66
67            "oidcClaim": "email"
68
69        },
70
71    {
72
73            "jsonLdFqn": "http://schema.org/gender",
74
75            "oidcClaim": "gender"
76
77        },
78
79    {
80
81            "jsonLdFqn": "http://schema.org/birthDate",
82
83            "oidcClaim": "birthdate"
84
85        },
86
87    {
88
89            "jsonLdFqn": "http://schema.org/knowsLanguage",
90
91            "oidcClaim": "locale"
92
93        },
94
95        {
96
97            "jsonLdFqn": "http://schema.org/telephone",
98
99            "oidcClaim": "phone_number"
100
101        }
102
103  ]

Note: The OIDC Bridge only maps credential terms to strings in the OIDC ID Token, therefore the default OIDC Address claim is not supported at this time.

Custom terms

Any other claim from the Credential can be mapped. The OpenID Connect recommendation is to name-space custom claims so as to avoid any collision with standard claims, current or future.

As the platform only supports schema.org as a data vocabulary currently, name-spacing with this domain is logical, alternatively any unique value like your host domain is valid.

The jsonLdFqn value must be an exact match for a fully-expanded JSON-LD Subject claim in the Credential, otherwise it will be ignored during credential issue.

json
Copy to clipboard.
1"claimMappings": [
2
3    {
4
5            "jsonLdFqn": "http://schema.org/alumniOf",
6
7            "oidcClaim": "schema.org/alumni_of"
8
9        }
10
11    ]