Consumer Data Right Register Design - v1.4.0 Release Notes

V1.4.0 Release Notes

V1.4.0 Release Notes

Release notes for version 1.4.0 of the CDR Register Design.

Introduction

Section	Change	GitHub Issue	Description
Data Standards Body	Updated DSB's role		- Updated DSB's role to align with the Consumer Data Standards website

Consumer Data Right Register

Section	Change	GitHub Issue	Description
Participant Brands	Added section on participant brands	#163	- Participant Brands section directs reader to the article provided on the CDR Support Portal
Data Holder	Updated section on data holder	#158	- Clarified metrics collection occurs per data holder brand

Client Registration

Section	Change	GitHub Issue	Description
Registration Validation	Updated section on registration validation	#167	- Provided reference to the JWKS endpoint published by the CDR Register used for SSA signature verification

Participant Statuses

Section	Change	GitHub Issue	Description
Accredited Data Recipient and Software Product Statuses	Added section on archiving entities	#164	- Archiving section covers logic when entities are removed from the API results
Checking Request Validity	Updated section on Request for Consent Withdrawal	#156	- Clarified JWKS call by ADR to DH to authenticate request

Security Profile

Section	Change	GitHub Issue	Description
Client Authentication	Updated CDR Register Access Token Request using Client Authentication		- Corrected description to reference JWT instead of ID token as ID tokens are not relevant in authenticating with the Register - Included deprecation notice on `Data Recipient Brand ID` as a client identifier
Client Authentication	Updated client authentication from CDR Register	#139	Updated reference to the CDS for calls made from the CDR Register to participants
Client Registration Management	Updated Client Registration Management	#166	- Added section dedicated to PUT operations
JWKS Cache Management	Added JWKS Cache Management	#153	- Added section outlining that JWKS results should be cached and refreshed periodically
Certificate Management	Added Certificate Validation	#113	- Added section summarising certificate validation requirements and referencing the article on the CDR Support Portal
Certificate Management	Added OCSP Stapling Clarification	#113	- Added clarification that OCSP stapling is not a requirement for certificate management

Register APIs

Section	Change	GitHub Issue	Description
GetOpenIdProviderConfig	Added API for OIDC Config discovery	#110	Added GetOpenIdProviderConfig API as currently being exposed by the CDR Register
GetJWKS	Added API for CDR Register JWKS	#110	Added GetJWKS API as currently being exposed by the CDR Register
Get SSA API	Updated Swagger error codes	#142	Added 422 error code for invalid SSA fields. Updated remaining error code descriptions
General	Updated Swagger X-V Header description	#133	Corrected the X-V header description to align to the CDS Headers