Read All User Agreement Consents

GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/agreementConsents

The GET /environments/{{envID}}/users{{userID}}/agreementConsents operation returns the current agreement consent state for all of a user's agreement consents.

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f880dacd-19d1-4d4e-9f2e-9d175bd03e1b/agreementConsents"}},"_embedded":{"agreementConsents":[{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f880dacd-19d1-4d4e-9f2e-9d175bd03e1b/agreementConsents/43eb5621-eae8-4fa1-aafb-2a884d6848cb"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"agreement":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/43eb5621-eae8-4fa1-aafb-2a884d6848cb"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f880dacd-19d1-4d4e-9f2e-9d175bd03e1b"}},"_embedded":{"agreement":{"id":"43eb5621-eae8-4fa1-aafb-2a884d6848cb","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Agreement_1_UPDATED_1601679632","reconsentPeriodDays":360,"totalConsents":0,"totalExpiredConsents":0,"consentsAggregatedAt":"2021-01-15T20:45:17.463Z","enabled":false}},"id":"43eb5621-eae8-4fa1-aafb-2a884d6848cb","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"f880dacd-19d1-4d4e-9f2e-9d175bd03e1b"},"agreement":{"id":"43eb5621-eae8-4fa1-aafb-2a884d6848cb"},"status":"AGREEMENT_DISABLED"},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f880dacd-19d1-4d4e-9f2e-9d175bd03e1b/agreementConsents/49d7aa39-41a0-4a6d-bafd-84cc5abf98f5"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"agreement":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/49d7aa39-41a0-4a6d-bafd-84cc5abf98f5"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f880dacd-19d1-4d4e-9f2e-9d175bd03e1b"}},"_embedded":{"agreement":{"id":"49d7aa39-41a0-4a6d-bafd-84cc5abf98f5","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Agreement_2","description":"Terms of service agreement","reconsentPeriodDays":180,"enabled":false}},"id":"49d7aa39-41a0-4a6d-bafd-84cc5abf98f5","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"f880dacd-19d1-4d4e-9f2e-9d175bd03e1b"},"agreement":{"id":"49d7aa39-41a0-4a6d-bafd-84cc5abf98f5"},"status":"AGREEMENT_DISABLED"}]},"size":2,"count":2}