OneTrust Platform — Global Activity

{"openapi":"3.1.0","info":{"title":"Platform - Global Activity","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my.onetrust.com/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}},"servers":[{"url":"https://{hostname}","variables":{"hostname":{"default":"hostname","description":"The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."}}}],"tags":[{"name":"Activity Log"}],"paths":{"/api/audit/v4/audits/event-types":{"get":{"tags":["Activity Log"],"summary":"Get List of Event Types","description":"Use this API to retrieve a list of event types for which user and system activity are tracked. Additional filter criteria can be applied to further filter results by product area or record type. The response will include details such as the code, name, object type, and product area for each event type.","operationId":"getEventTypeFilterOptionsGET","parameters":[{"name":"modules","in":"query","description":"Module Names for which Event Types are required","required":false,"schema":{"type":"array","items":{"type":"string","example":"User management"}}},{"name":"objectTypes","in":"query","description":"Object Type Names for which Event Types are required","required":false,"schema":{"type":"array","items":{"type":"string","example":"User"}}}],"responses":{"200":{"description":"Event Types successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventType"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"format":"int32","description":"The number of seconds after which requests will be allowed again."}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"format":"uuid","description":"The unique identifier for the rate-limiting event."}},"ot-request-made":{"schema":{"format":"int32","description":"The number of requests made within the specified period."}},"ot-requests-allowed":{"schema":{"format":"int32","description":"The number of requests allowed within the specified period."}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["ACTIVITY_LOG"]}]}}},"components":{"schemas":{"EventType":{"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"Event Type Code","example":1001},"value":{"type":"string","description":"Event Type Name","example":"User created"},"objectTypeName":{"type":"string","description":"The Object Type Name to which the Event Type belongs to","example":"User"},"moduleName":{"type":"string","description":"The Module Name to which the Event Type belongs to","example":"User management"}}}},"securitySchemes":{"OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"ACTIVITY_LOG":"Grants access to Activity Logs"}}}}}},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"x-onetrust":{"spec-label":"OpenAPI 3.1.0"}}