/consents/{ownerCompositeKey}/applications/{applicationId}
This resource is available only to principals with these entitlements: "ROLE_CREATE_OWN_CONSENT" "ROLE_CREATE_OTHER_CONSENT" "ROLE_BROKER_ADMIN"
Mount Point: /privacy/v1/consents/{ownerCompositeKey}/applications/{applicationId}/
The following operations are supported on this resource:
POST
This operation is available only to principals with these entitlements: "ROLE_CREATE_OWN_CONSENT" "ROLE_CREATE_OTHER_CONSENT" "ROLE_BROKER_ADMIN"
Adds a consent for a given application, action, and purpose.
Parameters
| name | description | type | default |
|---|---|---|---|
| ownerCompositeKey | The key to use to identify the consent owner. | path | |
| applicationId | The application id associated with the consent to be added. | path | |
| actionId | The action id associated with the consent to be added. | query | read@ |
| purposeId | The purpose id associated with the consent to be added. | query | Any@ |
| resourceIds | The resource ids associated with the consent to be added. Resource ids are specified in a comma-separated format. | query |
Response Body
| element: | (custom) |
| media types: | application/json |
Consent added to the consent store.
Status Codes
| code | description |
|---|---|
| 201 | Success |
| 404 | No such object |
GET
This operation is available only to principals with these entitlements: "ROLE_READ_OWN_CONSENT" "ROLE_READ_OTHER_CONSENT" "ROLE_BROKER_ADMIN"
Gets consents associated with the given owner and application.
Parameters
| name | description | type | default |
|---|---|---|---|
| ownerCompositeKey | The key to use to find the owner requested. | path | |
| applicationId | The application id to get consents for. | path | |
| startIndex | The index number of the first item to be provided in the results. A null value is equivalent to 0. | query | |
| count | The maximum number of items to be provided in the results. A null value signifies no maximum. | query |
Response Body
| element: | (custom) |
| media types: | application/json |
Paged list of consents associated with the given owner and application.
Status Codes
| code | description |
|---|---|
| 200 | Success |
| 404 | No such object |
DELETE
This operation is available only to principals with these entitlements: "ROLE_DELETE_OWN_CONSENT" "ROLE_DELETE_OTHER_CONSENT" "ROLE_BROKER_ADMIN"
Deletes all consents associated with the given owner, application and optional resource id(s).
Parameters
| name | description | type | default |
|---|---|---|---|
| ownerCompositeKey | The key to use to identify the consent owner. | path | |
| applicationId | The application id associated with the consents to be deleted. | path | |
| resourceIds | Optional resource ids associated with the consent to be deleted. Resource ids are specified in a comma-separated format. | query |
Status Codes
| code | description |
|---|---|
| 204 | Success |
| 404 | No such object |