Identity Broker REST API Reference

UnboundID Logo

/consents/{ownerCompositeKey}/resources/{resourceId}

This resource is available only to principals with these entitlements: "ROLE_READ_OWN_CONSENT" "ROLE_READ_OTHER_CONSENT" "ROLE_BROKER_ADMIN"

Mount Point: /privacy/v1/consents/{ownerCompositeKey}/resources/{resourceId}/

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 given resource.

Parameters

name description type default
ownerCompositeKey The key to use to find the requested owner. path
resourceId The resource 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
includeGroups true to return consents where resourceId may be a member of a resource group in the consented resources list. Otherwise false means the resourceId must be explicitly listed in the consented resources list. The default is true. query true

Response Body

element: (custom)
media types: application/json

Paged list of consents associated with the given owner and resource.

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 and resource.

Parameters

name description type default
ownerCompositeKey The key to use to identify the consent owner. path
resourceId The resource id associated with the consents to be deleted. path

Status Codes

code description
204 Success
404 No such object