ConsumerDataStandardsAustralia / register

ACCC CDR Register GitHub issue register for external collaboration
https://cdr-register.github.io/register/
38 stars 4 forks source link

Improve documentation for DH to ADR calls #156

Closed CDR-Register-Stream closed 3 years ago

CDR-Register-Stream commented 3 years ago

There is a gap in documentation on how a DH should sequence events to call an ADR.

The documentation would benefit from the following improvements:

  1. Outline use case(s)
  2. Authentication with reference to the DH JWKS_URI exposed in the GetDataHolderBrands API call
  3. Reference retry patterns when ADR is unavailable
  4. Outline error scenarios which the ADR may need to handle
CDR-Register-Stream commented 3 years ago

V1.4.0 of the CDR Register Design adds reference to the Data Holder JWKS endpoints to use for the ADR to authenticate the data holder. This has been clarified in the Request For Consent Withdrawal sequence diagram.

Further work on technical commentary on JWKS usage within the CDR is planned to be published on the CDR Support Portal.

Please stay tuned.

CDR-Register-Stream commented 3 years ago

closed as complete. Further updates will be published on the CDR Support Portal