Identity Broker REST API Reference

UnboundID Logo

/consents/{ownerCompositeKey}/consented/resources

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}/consented/resources/

GET

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

Get a list of all resources, or a given resource id, that a given owner has consented to.

Parameters

name description type default
ownerCompositeKey The key to use to find the owner requested. path
resourceId Optional resource id to search for. Can be null to return resources for all consented applications. query
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
sortBy Specifies how the results should be sorted. Allowed values are defined by com.unboundid.policy.models.Resource#getSortsByEnumValues(). A null value returns items in an unspecified order. query NAME_ASCENDING
includeGroups true to return resource groups in the results false to return non-group results. query true
filterBy Specifies how filtering will occur. Allowed values are defined in com.unboundid.policy.models.Resource#getFiltersByEnumValues(). query
filter user-supplied input used for filtering. query
excludesList comma-separated list of ids to exclude from results. query
urnFilter optional urn filter to apply in addition to the filtering specified by filterBy and filterInput parameters. query

Response Body

result: resource
media types: application/json

Paged list of consented Resources.

Status Codes

code description
200 Success
404 No such object