Consent Requests

Update Consent Request State

Changed on

Updates the status of a specific consent request. Withdrawing is only accessible to the data consumer owning the related data request, all other status changes only to the data producer assigned to the consent request.

put/api/agreement/v1/consent-requests/{id}/status

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (http://localhost:6999/realms/agate/.well-known/openid-configuration, scopes: agridata.ch.Agridata_Einwilliger, agridata.ch.Agridata_Datenbezueger)

Path parameters

idstring uuid required

ID of the consent request

Query parameters

actingRole'CONSUMER' | 'PRODUCER'

Selects the role in which the authenticated user acts for this request. Optional: if the authenticated user holds exactly one of the allowed roles, the value is auto-resolved. Returns 400 if the value is unknown, not allowed for this endpoint, or omitted while the user holds multiple matching roles. Returns 403 if the user does not hold the role specified in the parameter.

Request body

'GRANTED' | 'OPENED' | 'DECLINED' | 'LEGALLY_PERMITTED' | 'NOT_CREATED' | 'WITHDRAWN' required

Possible states of a consent request:

  • GRANTED: Consent has been granted
  • OPENED: Consent request is open and awaiting response
  • DECLINED: Consent has been declined
  • NOT_CREATED: Placeholder to indicate that no consent request exists yet for a given UID.

Response

No Content

Changes

  • 75957f6bdc66Revision changes
    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

  • ae5c7d8cdb15Revision changes
    • info

      the security scope agridata.ch.Agridata_Datenbezueger was added to the endpoint's security scheme SecurityScheme

    • info

      added the new optional query request parameter actingRole