Release Notes

This release contains the definition and documentation of

• consent-info v0.2.0-rc.1

The API definition(s) are based on

• Commonalities r3.4
• Identity and Consent Management r3.3

consent-info v0.2.0-rc.1

consent-info v0.2.0-rc.1 is the first release candidate of the version 0.2.0

consent-info API v0.2.0 introduces enhancements to improve user experience and clarity in consent management. Key updates include the addition of an optional callbackUrl parameter for redirecting users post-consent, refined status terminology replacing REVOKED with DENIED, and expanded test scenarios to ensure robust handling of new features.

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Added support for an optional callbackUrl parameter in the consent capture request, allowing API Consumers to specify where the user should be redirected after completing the consent flow by @jpengar in #41
• Added error code CONSENT_INFO.INVALID_CALLBACK_URL and example for invalid callback URLs, ensuring that API Providers return a clear 403 error when the callback URL fails validation by @jpengar in #41
• Included a new request example ONE_SCOPE_CALLBACK_URL demonstrating usage of the `callbackUrl field in API requests by @jpengar in #41
• Added a new response example CONSENT_DENIED to illustrate how the API responds when consent is explicitly denied for a scope and purpose by @jpengar in #41
• Extended test scenarios to cover callback URL behavior, including handling the state parameter and verifying correct redirection and result propagation by @jpengar in #41

Changed

• Replaced the status value REVOKED with DENIED throughout the API, updating both the schema and the documentation to clarify that DENIED covers both explicit refusal and withdrawal of consent by @jpengar in #41

Fixed

• N/A

Removed

• N/A

Full Changelog: r1.2...r2.1

Release Notes

This release contains the definition and documentation of

• consent-info v0.1.0

The API definition(s) are based on

• Commonalities r3.3
• Identity and Consent Management r3.3

consent-info v0.1.0

consent-info v0.1.0 is the first public version of this API.

Version 0.1.0 provides the initial API definition and documentation for the consent-info API, which is part of the Identity and Consent Management (ICM) Working Group.

• This API version provides the API consumer with the ability to:

  • Check the validity of data processing: The API returns statusValidForProcessing, a boolean flag that indicates whether the requested data processing is currently permitted (true) or not (false).
  • Understand why processing is not allowed: If data processing is not permitted, the response includes a statusReason field to explain why.
  • Retrieve a Capture URL (if requested): If the status is not valid because user action is required, and the API Consumer sets requestCaptureUrl to true, the API will return a captureUrl field that can be presented to the user. This URL directs them to the API Provider's secure consent capture channel, where they can provide or renew their consent.

• API definition with inline documentation:

  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Initial consent-info API definition and documentation

Changed

• N/A

Fixed

• N/A

Removed

• N/A

Full Changelog: https://github.com/camaraproject/ConsentInfo/commits/r1.2

Release Notes

This release contains the definition and documentation of

• consent-info v0.1.0-rc.1

The API definition(s) are based on

• Commonalities r3.2
• Identity and Consent Management r3.2

consent-info v0.1.0-rc.1

consent-info v0.1.0-rc.1 is is the first release candidate of the version 0.1.0

Version 0.1.0 provides the initial API definition and documentation for the consent-info API, which is part of the Identity and Consent Management (ICM) Working Group.

• This API version provide the API consumer with the ability to:

  • Check the validity of data processing: The API returns statusValidForProcessing, a boolean flag that indicates whether the requested data processing is currently permitted (true) or not (false).
  • Understand why processing is not allowed: If data processing is not permitted, the response includes a statusReason field to explain why.
  • Retrieve a Capture URL (if requested): If the status is not valid because user action is required, and the API Consumer sets requestCaptureUrl to true, the API will return a captureUrl field that can be presented to the user. This URL directs them to the API Provider's secure consent capture channel, where they can provide or renew their consent.

• API definition with inline documentation:

  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Initial consent-info API definition and documentation

Changed

• N/A

Fixed

• N/A

Removed

-N/A

Full Changelog: https://github.com/camaraproject/ConsentInfo/commits/r1.1