/{userId}/consentHistory
Mount Point: /metadata/v1/{userId}/consentHistory/
GET
Retrieves consent history.
Parameters
| name | description | type | default |
|---|---|---|---|
| userId | The ID of the owner to retrieve history for. | path | |
| startIndex | The index number of the first item to be provided in the results. A null value is equivalent to 0. | query | 0 |
| 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 OPERATION_ASCENDING, OPERATION_DESCENDING, ACTOR_ASCENDING, ACTOR_DESCENDING, APP_NAME_ASCENDING, APP_NAME_DESCENDING, DATETIME_ASCENDING, DATETIME_DESCENDING, PURPOSE_NAME_ASCENDING, PURPOSE_NAME_DESCENDING, RESOURCE_NAME_ASCENDING, RESOURCE_NAME_DESCENDING. A null value returns items in an unspecified order. | query | |
| filter | Optional user-supplied input used for filtering. If null or empty, no items are filtered. | query | |
| application | The application name to filter the results by. If specified, clientId cannot be used. If neither application nor clientId is specified, records for all applications are returned. | query | |
| clientId | The OAuth client ID of the application to filter the results by. If specified, application cannot be used. If neither application nor clientId is specified, records for all applications are returned. | query | |
| resource | The resource name or URN to filter the results by, or null if results are not to be filtered by resource. | query | |
| action | The action name to filter the results by, or null if results are not to be filtered by action. | query | |
| purpose | The purpose name to filter the results by, or null if results are not to be filtered by purpose. | query | |
| operation | Optional for filtering by operation type. Valid values are "capture" and "revoke". If null no items are filtered. | query | |
| startTime |
Optional start time for the requested data. This value may be in a relative form which will be calculated relative to the time of the request, or it may be in an absolute form using ISO8601 format. Relative form uses the syntax: -N[mhdwMy] which is interpreted to mean N time-units before now. Absolute form uses the ISO8601 syntax of YYYY-MM-DDThh:mm:ss where you can specify a partial date by omitting fields on the right (without skipping any fields). For example, 2013-01-01 is a valid timestamp that mean midnight on January 1st 2013 If no timezone is specified the server timezone is used.. |
query | |
| endTime |
Optional end time for the requested data. This value may be in a relative form which will be calculated relative to startTime, or it may be in an absolute form using ISO8601 format. Relative form uses the syntax: N[mhdwMy] which is interpreted to mean N time-units after startTime. Absolute form uses the ISO8601 syntax of YYYY-MM-DDThh:mm:ss where you can specify a partial date by omitting fields on the right (without skipping any fields). For example, 2013-01-01 is a valid timestamp that mean midnight on January 1st 2013. If no timezone is specified the server timezone is used. |
query |
Response Body
| result: | consentHistory |
| media types: | application/json |
Paged list of consent history associated with the given owner.
Status Codes
| code | description |
|---|---|
| 200 | Success |