You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/credential-data-model.rst
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,8 @@
2
2
.. include:: ../common/common_definitions.rst
3
3
4
4
5
-
PID/(Q)EAA Data Model
6
-
=====================
5
+
Digital Credential Data Model
6
+
==============================
7
7
8
8
The Digital Credential Data Model structures Digital Credentials for secure, interoperable use. Key elements include:
9
9
@@ -23,7 +23,7 @@ The User attributes provided within the Italian PID are the ones listed below:
23
23
24
24
The (Q)EAAs are issued by (Q)EAA Issuers to a Wallet Instance and MUST be provided in SD-JWT-VC or mdoc-CBOR data format.
25
25
26
-
The PID/(Q)EAA data format and the mechanism through which a digital credential is issued to the Wallet Instance and presented to a Relying Party are described in the following sections.
26
+
The Digital Credential data format and the mechanism through which a Digital Credential is issued to the Wallet Instance and presented to a Relying Party are described in the following sections.
27
27
28
28
SD-JWT-VC Credential Format
29
29
---------------------------
@@ -62,7 +62,7 @@ The Disclosures are provided to the Holder together with the SD-JWT in the *Comb
62
62
See `SD-JWT-VC`_ and `SD-JWT`_ for additional details.
63
63
64
64
65
-
PID/(Q)EAA SD-JWT Parameters
65
+
Credential SD-JWT Parameters
66
66
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67
67
68
68
The JOSE header contains the following mandatory parameters:
@@ -122,7 +122,7 @@ The JWT payload contains the following claims. Some of these claims can be discl
122
122
- [NSD]. OPTIONAL. UNIX Timestamp with the start time of validity of the JWT, coded as NumericDate as indicated in :rfc:`7519`.
The Pushed Authorization Endpoint is protected with OAuth 2.0 Attestation-based Client Authentication [`OAUTH-ATTESTATION-CLIENT-AUTH`_], therefore
69
-
the request to the PID/(Q)EAA authorization endpoint MUST use the following HTTP Headers parameters:
69
+
the request to the Credential Issuer authorization endpoint MUST use the following HTTP Headers parameters:
70
70
71
71
.. _table_http_request_headers_claim:
72
72
.. list-table:: http request header parameters
@@ -316,7 +316,7 @@ The mandatory parameters in the HTTP authentication request are specified in the
316
316
Authorization Response
317
317
^^^^^^^^^^^^^^^^^^^^^^^
318
318
319
-
The authentication response is returned by the PID/(Q)EAA authorization endpoint at the end of the authentication flow.
319
+
The authentication response is returned by the Credential issuer authorization endpoint at the end of the authentication flow.
320
320
321
321
If the authentication is successful the Credential Issuer redirects the User by adding the following query parameters as required to the *redirect_uri*. The redirect URI MUST be an universal or app link registered with the local operating system, so this latter is able to provide the response to the Wallet Instance.
322
322
@@ -408,10 +408,10 @@ defined in :rfc:`6749`. The Token Endpoint is a protected endpoint with a client
408
408
Token Request
409
409
^^^^^^^^^^^^^
410
410
411
-
The request to the PID/(Q)EAA Token endpoint MUST be an HTTP request with method POST, with the body message encoded in ``application/x-www-form-urlencoded`` format. The Wallet Instance sends the Token endpoint request with ``OAuth-Client-Attestation`` and ``OAuth-Client-Attestation-PoP`` as header parameters according to `OAUTH-ATTESTATION-CLIENT-AUTH`_.
411
+
The request to the Credential Issuer Token endpoint MUST be an HTTP request with method POST, with the body message encoded in ``application/x-www-form-urlencoded`` format. The Wallet Instance sends the Token endpoint request with ``OAuth-Client-Attestation`` and ``OAuth-Client-Attestation-PoP`` as header parameters according to `OAUTH-ATTESTATION-CLIENT-AUTH`_.
412
412
413
413
The Token endpoint is protected with *OAuth 2.0 Attestation-based Client Authentication* [`OAUTH-ATTESTATION-CLIENT-AUTH`_], therefore
414
-
the request to the PID/(Q)EAA authorization endpoint MUST use the following HTTP Headers parameters **OAuth-Client-Attestation** as **OAuth-Client-Attestation-PoP**
414
+
the request to the Credential Issuer authorization endpoint MUST use the following HTTP Headers parameters **OAuth-Client-Attestation** as **OAuth-Client-Attestation-PoP**
415
415
as defined in the "Pushed Authorization Request (PAR) Endpoint".
416
416
417
417
The Token endpoint issues DPoP tokens, therefore it is REQUIRED that the request includes in its HTTP header the DPoP proof parameter.
@@ -508,7 +508,7 @@ If the Token Request is successfully validated, the Authorization Server provide
508
508
- **Description**
509
509
- **Reference**
510
510
* - **access_token**
511
-
- REQUIRED. The *DPoP-bound Access Token*, in signed JWT format, allows accessing the PID/(Q)EAA Credential Endpoint for obtaining the Credential.
511
+
- REQUIRED. The *DPoP-bound Access Token*, in signed JWT format, allows accessing the Credential Endpoint for obtaining the Credential.
512
512
- [:rfc:`6749`].
513
513
* - **refresh_token**
514
514
- OPTIONAL. The *DPoP-bound Refresh Token*, in signed JWT format, which can be used to obtain a new Access Token at the Credential Issuer Token Endpoint.
@@ -580,7 +580,7 @@ In the following table are listed HTTP Status Codes and related error codes that
580
580
Access Token
581
581
^^^^^^^^^^^^
582
582
583
-
A DPoP-bound Access Token is provided by the PID/(Q)EAA Token endpoint as a result of a successful token request. The Access Token is encoded in JWT format, according to [:rfc:`7519`]. The Access Token MUST have at least the following mandatory claims and it MUST be bound to the public key that is provided by the DPoP proof. This binding can be accomplished based on the methodology defined in Section 6 of (:rfc:`9449`).
583
+
A DPoP-bound Access Token is provided by the Credential Issuer Token endpoint as a result of a successful token request. The Access Token is encoded in JWT format, according to [:rfc:`7519`]. The Access Token MUST have at least the following mandatory claims and it MUST be bound to the public key that is provided by the DPoP proof. This binding can be accomplished based on the methodology defined in Section 6 of (:rfc:`9449`).
584
584
585
585
The **DPoP JWT** contains the following JOSE header parameters and claims.
586
586
@@ -615,7 +615,7 @@ The **DPoP JWT** contains the following JOSE header parameters and claims.
615
615
- REQUIRED. It MUST be an HTTPS URL that uniquely identifies the Credential Issuer. The Wallet Instance MUST verify that this value matches the Credential Issuer where it has requested the credential.
616
616
- [:rfc:`9068`], [:rfc:`7519`].
617
617
* - **sub**
618
-
- REQUIRED. It identifies the subject of the JWT. It MUST be set to the value of the ``sub`` field in the PID/(Q)EAA SD-JWT-VC.
618
+
- REQUIRED. It identifies the subject of the JWT. It MUST be set to the value of the ``sub`` field in the SD-JWT-VC Credential.
619
619
- [:rfc:`9068`], [:rfc:`7519`] and Section 8 of [`OIDC`_].
620
620
* - **client_id**
621
621
- REQUIRED. The identifier for the Wallet Instance that requested the Access Token; it MUST be equal to the to kid of the public key of the Wallet Instance specified into the Wallet Attestation (``cnf.jwk``).
@@ -639,7 +639,7 @@ The **DPoP JWT** contains the following JOSE header parameters and claims.
639
639
Refresh Token
640
640
^^^^^^^^^^^^^
641
641
642
-
A *DPoP-bound Refresh Token* is provided by the PID/(Q)EAA Token endpoint as a result of a successful token request. The Refresh Token is encoded in JWT format, according to [:rfc:`7519`]. The Refresh Token MUST have at least the following mandatory claims and it MUST be bound to the public key that is provided by the DPoP proof. This binding can be accomplished based on the methodology defined in Section 6 of (:rfc:`9449`).
642
+
A *DPoP-bound Refresh Token* is provided by the Credential Issuer Token endpoint as a result of a successful token request. The Refresh Token is encoded in JWT format, according to [:rfc:`7519`]. The Refresh Token MUST have at least the following mandatory claims and it MUST be bound to the public key that is provided by the DPoP proof. This binding can be accomplished based on the methodology defined in Section 6 of (:rfc:`9449`).
643
643
644
644
The **DPoP JWT** MUST contain the following JOSE header parameters and claims.
645
645
@@ -674,7 +674,7 @@ The **DPoP JWT** MUST contain the following JOSE header parameters and claims.
674
674
- It MUST be an HTTPS URL that uniquely identifies the Credential Issuer. The Wallet Instance MUST verify that this value matches the Credential Issuer where it has requested the Credential.
675
675
- [:rfc:`9068`], [:rfc:`7519`].
676
676
* - **sub**
677
-
- It identifies the subject of the JWT. It MUST be set to the value of the ``sub`` field in the PID/(Q)EAA SD-JWT-VC.
677
+
- It identifies the subject of the JWT. It MUST be set to the value of the ``sub`` field in the SD-JWT-VC Credential.
678
678
- [:rfc:`9068`], [:rfc:`7519`] and Section 8 of [`OIDC`_].
679
679
* - **client_id**
680
680
- The identifier for the Wallet Instance that requested the Access Token; it MUST be equal to the to `kid` value identifying the public key used in the Wallet Instance, used in the Wallet Attestation (``cnf.jwk``).
@@ -738,7 +738,7 @@ The Credential Endpoint issues a Credential upon the presentation of a valid Acc
738
738
Credential Request
739
739
^^^^^^^^^^^^^^^^^^^
740
740
741
-
The Wallet Instance when requests the PID/(Q)EAA to the PID/(Q)EAA Credential endpoint, MUST use the following parameters in the message body of the HTTP POST request, using the `application/json` media type.
741
+
The Wallet Instance when requests the Digital Credential to the Credential endpoint, MUST use the following parameters in the message body of the HTTP POST request, using the `application/json` media type.
742
742
743
743
The Credential endpoint MUST accept and validate the *DPoP proof* sent in the DPoP HTTP Header parameter, according to the steps defined in (:rfc:`9449`) Section 4.3. The *DPoP proof* in addition to the values that are defined in the Token Endpoint section MUST contain the following claim:
744
744
@@ -790,7 +790,7 @@ The JWT proof type MUST contain the following parameters for the JOSE header and
790
790
- It MUST be set to `openid4vci-proof+jwt`.
791
791
- [`OpenID4VCI`_], [:rfc:`7515`], [:rfc:`7517`].
792
792
* - **jwk**
793
-
- Representing the public key chosen by the Wallet Instance, in JSON Web Key (JWK) [:rfc:`7517`] format that the PID/(Q)EAA shall be bound to, as defined in Section 4.1.3 of [:rfc:`7515`].
793
+
- Representing the public key chosen by the Wallet Instance, in JSON Web Key (JWK) [:rfc:`7517`] format that the Digital Credential shall be bound to, as defined in Section 4.1.3 of [:rfc:`7515`].
794
794
- [`OpenID4VCI`_], [:rfc:`7515`], [:rfc:`7517`].
795
795
796
796
.. list-table::
@@ -834,7 +834,7 @@ The Credential Response contains the following parameters:
834
834
* - **credentials**
835
835
- REQUIRED if ``lead_time`` and ``transaction_id`` are not present, otherwise it MUST NOT be present. It contains the following parameters:
836
836
837
-
- **credential**: REQUIRED. String containing one issued PID/(Q)EAA. If the requested format identifier is ``dc+sd-jwt`` then the ``credential`` parameter MUST NOT be re-encoded. If the requested format identifier is ``mso_mdoc`` then the ``credential`` parameter MUST be a base64url-encoded representation of the CBOR-encoded IssuerSigned structure, as defined in [ISO 18013-5]. This structure SHOULD contain all Namespaces and IssuerSignedItems that are included in the AuthorizedNamespaces of the MobileSecurityObject.
837
+
- **credential**: REQUIRED. String containing one issued Digital Credential. If the requested format identifier is ``dc+sd-jwt`` then the ``credential`` parameter MUST NOT be re-encoded. If the requested format identifier is ``mso_mdoc`` then the ``credential`` parameter MUST be a base64url-encoded representation of the CBOR-encoded IssuerSigned structure, as defined in [ISO 18013-5]. This structure SHOULD contain all Namespaces and IssuerSignedItems that are included in the AuthorizedNamespaces of the MobileSecurityObject.
838
838
- Section 8.3, Annex A2.4 and Annex A3.4 of [`OpenID4VCI`_].
839
839
* - **lead_time**
840
840
- REQUIRED if ``credentials`` is not present, otherwise it MUST NOT be present. The amount of time (in seconds) required before making a Deferred Credential Request.
0 commit comments