{"components":{"schemas":{"AuditAttributeJson":{"properties":{"name":{"type":"string"},"nameI18nKey":{"type":"string"},"value":{"type":"string"}},"type":"object"},"AuditAuthorJson":{"properties":{"avatarUri":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uri":{"type":"string"}},"type":"object"},"AuditCoverageConfigJson":{"properties":{"levelByArea":{"additionalProperties":{"enum":["off","base","advanced","full"],"type":"string"},"type":"object"}},"type":"object"},"AuditEntitiesResponseJson":{"properties":{"entities":{"items":{"$ref":"#/components/schemas/AuditEntityJson"},"type":"array"},"pagingInfo":{"$ref":"#/components/schemas/PagingInfoAuditEntityCursor"}},"type":"object"},"AuditEntityJson":{"properties":{"affectedObjects":{"items":{"$ref":"#/components/schemas/AuditResourceJson"},"type":"array"},"author":{"$ref":"#/components/schemas/AuditAuthorJson"},"changedValues":{"items":{"$ref":"#/components/schemas/ChangedValueJson"},"type":"array"},"extraAttributes":{"items":{"$ref":"#/components/schemas/AuditAttributeJson"},"type":"array"},"method":{"type":"string"},"node":{"type":"string"},"source":{"type":"string"},"system":{"type":"string"},"timestamp":{"format":"date-time","type":"string"},"type":{"$ref":"#/components/schemas/AuditTypeJson"}},"type":"object"},"AuditExcludedActionsJson":{"properties":{"actions":{"items":{"type":"string"},"type":"array"}},"type":"object"},"AuditExcludedActionsModifyRequestJson":{"properties":{"actionsToAdd":{"items":{"type":"string"},"type":"array"},"actionsToDelete":{"items":{"type":"string"},"type":"array"}},"type":"object"},"AuditResourceJson":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"uri":{"type":"string"}},"type":"object"},"AuditRetentionConfigJson":{"properties":{"period":{"properties":{"chronology":{"properties":{"calendarType":{"type":"string"},"id":{"type":"string"}},"type":"object"},"days":{"format":"int32","type":"integer"},"months":{"format":"int32","type":"integer"},"negative":{"type":"boolean"},"units":{"items":{"properties":{"dateBased":{"type":"boolean"},"duration":{"properties":{"nano":{"format":"int32","type":"integer"},"negative":{"type":"boolean"},"seconds":{"format":"int64","type":"integer"},"zero":{"type":"boolean"}},"type":"object"},"durationEstimated":{"type":"boolean"},"timeBased":{"type":"boolean"}},"type":"object"},"type":"array"},"years":{"format":"int32","type":"integer"},"zero":{"type":"boolean"}},"type":"object"}},"type":"object"},"AuditRetentionFileConfigJson":{"properties":{"maxFileCount":{"format":"int32","type":"integer"}},"type":"object"},"AuditTypeJson":{"properties":{"action":{"type":"string"},"actionI18nKey":{"type":"string"},"category":{"type":"string"},"categoryI18nKey":{"type":"string"}},"type":"object"},"ChangedValueJson":{"properties":{"from":{"type":"string"},"i18nKey":{"type":"string"},"key":{"type":"string"},"to":{"type":"string"}},"type":"object"},"ErrorDescription":{"properties":{"key":{"type":"string"},"message":{"type":"string"}},"type":"object"},"PagingInfoAuditEntityCursor":{"properties":{"lastPage":{"type":"boolean"},"nextPageCursor":{"$ref":"#/components/schemas/RestPageCursor"},"nextPageLink":{"type":"string"},"nextPageOffset":{"format":"int32","type":"integer"},"size":{"format":"int32","type":"integer"}},"type":"object"},"ResponseErrorJson":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorDescription"},"type":"array"},"message":{"type":"string"},"status":{"format":"int32","type":"integer"},"timestamp":{"type":"string"}},"type":"object"},"RestPageCursor":{"properties":{"cursor":{"type":"string"}},"type":"object"}}},"info":{"description":"Cross-product audit feature APIs. The root path is /rest/auditing/1.0","title":"Audit","version":"1.0.0"},"openapi":"3.0.1","paths":{"/cache/rebuild":{"post":{"operationId":"scheduleCacheRebuild","responses":{"204":{"description":"Successful operation"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}},"summary":"Rebuilds caches used by the audit feature (e.g actions and categories","tags":["audit","cache"]}},"/configuration/coverage":{"get":{"operationId":"getAuditCoverageConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditCoverageConfigJson"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}}},"description":"Bad request"}},"summary":"Get current audit log coverage configuration","tags":["configuration"]},"put":{"operationId":"updateAuditCoverageConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditCoverageConfigJson"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditCoverageConfigJson"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}}},"description":"Bad request"}},"summary":"Set current audit log coverage configuration","tags":["configuration"]}},"/configuration/denylist":{"get":{"operationId":"getExcludedActions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditExcludedActionsJson"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}}},"description":"Bad request"}},"summary":"Get current excluded actions configuration","tags":["configuration"]},"post":{"operationId":"modifyExcludedActions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditExcludedActionsModifyRequestJson"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditExcludedActionsModifyRequestJson"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}}},"description":"Bad request"}},"summary":"Modify existing excluded actions configuration","tags":["configuration"]},"put":{"operationId":"replaceExcludedActions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditExcludedActionsJson"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditExcludedActionsJson"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}}},"description":"Bad request"}},"summary":"Replace existing exclude actions configuration","tags":["configuration"]}},"/configuration/retention":{"get":{"operationId":"getAuditRetentionConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditRetentionConfigJson"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}}},"description":"Bad request"}},"summary":"Get current audit log retention database configuration","tags":["configuration"]},"put":{"operationId":"updateAuditRetentionConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditRetentionConfigJson"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditRetentionConfigJson"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}}},"description":"Bad request"}},"summary":"Set current audit log retention database configuration","tags":["configuration"]}},"/configuration/retention/file":{"get":{"operationId":"getAuditRetentionFileConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditRetentionFileConfigJson"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}}},"description":"Bad request"}},"summary":"Get current audit log retention file configuration","tags":["configuration"]},"put":{"operationId":"updateAuditRetentionFileConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditRetentionFileConfigJson"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditRetentionFileConfigJson"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}}},"description":"Bad request"}},"summary":"Set current audit log retention file configuration","tags":["configuration"]}},"/events":{"get":{"operationId":"getAuditEvents","parameters":[{"description":"The start timestamp in ISO8601 format","example":"2019-11-01T01:00:00.000Z","in":"query","name":"from","schema":{"format":"date-time","type":"string"}},{"description":"The end timestamp in ISO8601 format","example":"2019-12-01T01:00:00.000Z","in":"query","name":"to","schema":{"format":"date-time","type":"string"}},{"description":"The number of records to skip","in":"query","name":"offset","schema":{"default":"0","format":"int32","minimum":0,"type":"string"}},{"description":"Location of last result returned in format of timestamp,ID. For making a request for page X, the value of this field can be obtained from pagingInfo->nextPageCursor in response for page X-1","example":"1577437517322,9","in":"query","name":"pageCursor","schema":{"type":"string"}},{"description":"The maximum number of records returned","in":"query","name":"limit","schema":{"default":"200","format":"int32","maximum":100000,"minimum":1,"type":"string"}},{"description":"Audit event author identifiers separated by comma","example":"42,46","in":"query","name":"userIds","schema":{"type":"string"},"style":"form"},{"description":"Audit categories separated by comma","example":"Global settings changed,Group deleted","in":"query","name":"categories","schema":{"type":"string"},"style":"form"},{"description":"Comma-separated list of actions which triggered the audit record","example":"Permissions,Apps","in":"query","name":"actions","schema":{"type":"string"},"style":"form"},{"description":"A list of affected objects separated by semicolon. Each affected object is a pair of object type and id separated by comma. Administrator permission of all affected objects is required when specified. Global administrator permission is required when no affected object is specified.","example":"space,42;space,46","in":"query","name":"affectedObject","schema":{"type":"string"}},{"description":"Search expression, this parameter may have negative performance impact. It's recommended to use scanLimit when this parameter is specified.","in":"query","name":"search","schema":{"type":"string"}},{"description":"What format output should the server create","in":"query","name":"outputFormat","schema":{"default":"json","type":"string"}},{"description":"The maximum number of records to be scanned in the inverse insertion order with from and to filters taking precedence, the default value is 2147483647 which means there is no limit","in":"query","name":"scanLimit","schema":{"default":"2147483647","format":"int32","maximum":2147483647,"minimum":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditEntitiesResponseJson"}},"text/csv":{"schema":{"$ref":"#/components/schemas/AuditEntitiesResponseJson"}}},"description":"Successful operation"},"400":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}},"text/csv":{"schema":{"items":{"$ref":"#/components/schemas/ResponseErrorJson"},"type":"array"}}},"description":"Bad request"}},"summary":"Get a paginated list of audit events","tags":["audit"]}}}}