{"items":[{"type":"link","label":"Celonis Audit Log API","link":"/celonis-apis/audit-log-api/openapi/openapi-external-v2","routeSlug":"/celonis-apis/audit-log-api/openapi/openapi-external-v2","content":{"contentType":"overview","meta":{"name":"Celonis Audit Log API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi-external-v2.json","url":"/_bundle/celonis-apis/audit-log-api/openapi/openapi-external-v2.json?download"},{"kind":"download","label":"openapi-external-v2.yaml","url":"/_bundle/celonis-apis/audit-log-api/openapi/openapi-external-v2.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"java","title":"Java","lang":"Java"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/celonis-apis/audit-log-api/openapi/openapi-external-v2","description":"Test Server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Celonis Audit Log API (v2.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the documentation for the Celonis Audit Log API that allows querying on audit logs in a Celonis Platform team. This API supports multiple methods of authentication:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (preferred method) Via OAuth 2.0 token with scope "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tt","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"audit.log:read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", passed in an HTTP header like this: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tt","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: Bearer TOKEN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Via Application keys, passed in an HTTP header like this: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tt","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: AppKey APPLICATION_KEY"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Via API keys, passed in an HTTP header like this: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tt","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: Bearer API_KEY"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.celonis.com/en/using-oauth-2-0.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this help page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about OAuth 2.0."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: ALL AUDIT LOG OPERATIONS ARE SCOPED TO A TEAM."},"children":[]}]}]}]}]}],"sectionId":"/celonis-apis/audit-log-api/openapi/openapi-external-v2"}],"sectionId":"/celonis-apis/audit-log-api/openapi/openapi-external-v2"}]}]}},{"type":"group","label":"Audit Log API","link":"/celonis-apis/audit-log-api/openapi/openapi-external-v2/audit-log-api","routeSlug":"/celonis-apis/audit-log-api/openapi/openapi-external-v2/audit-log-api","items":[{"label":"List Audit Logs (Token-based Pagination)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/celonis-apis/audit-log-api/openapi/openapi-external-v2/audit-log-api/getauditlogs","routeSlug":"/celonis-apis/audit-log-api/openapi/openapi-external-v2/audit-log-api/getauditlogs","metadata":{"seo":{"title":"List Audit Logs (Token-based Pagination)","description":"Audit Logs can be filtered by specifying a date interval. Retrieves a list of Audit Logs using a token-based pagination for high-performance scrolling. Use the nextPageToken from the response to fetch the next set of results. If there are more Audit Logs for the specified interval, nextPageToken will be returned for further querying.NOTE:  The USE AUDIT LOGS API permission must be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuditLogs","name":"List Audit Logs (Token-based Pagination)","isWebhook":false,"pointer":"/paths/~1api~1external~1v2~1audit/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Audit Logs (Token-based Pagination)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audit Logs can be filtered by specifying a date interval."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retrieves a list of Audit Logs using a token-based pagination for high-performance scrolling. Use the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nextPageToken"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the response to fetch the next set of results."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If there are more Audit Logs for the specified interval, "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nextPageToken"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned for further querying."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USE AUDIT LOGS API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission must be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":"Please, prefix the Token with \"AppKey \" or \"Bearer \" (word and space) to indicate the Authorization type"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_113","description":"encoded nextPageToken from the previous response","example":"eyI5ZTFkMzMwMy04N2Y4LTQ5NTEtOTkyNC02ZjhhY2E3MzY2MTUiOjE2Njk1Azk3NDAwMDB9"},{"name":"limit","in":"query","schemaId":"schema_114","description":"Limit of results","example":200},{"name":"from","in":"query","schemaId":"schema_115","description":"Start time (ISO 8601 Instant yyyy-MM-ddTHH:mm:ssZ)","example":"2021-01-01T09:00:00Z"},{"name":"to","in":"query","schemaId":"schema_115","description":"End time (ISO 8601 Instant yyyy-MM-ddTHH:mm:ssZ)","example":"2021-01-31T09:00:00Z"}],"pointer":"/paths/~1api~1external~1v2~1audit/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/external/v2/audit","servers":[{"url":"/_mock/celonis-apis/audit-log-api/openapi/openapi-external-v2","description":"Test Server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pageToken","in":"query","required":false,"example":"eyI5ZTFkMzMwMy04N2Y4LTQ5NTEtOTkyNC02ZjhhY2E3MzY2MTUiOjE2Njk1Azk3NDAwMDB9","schemaId":"schema_113"},{"name":"limit","in":"query","required":false,"example":200,"schemaId":"schema_114"},{"name":"from","in":"query","required":false,"example":"2021-01-01T09:00:00Z","schemaId":"schema_115"},{"name":"to","in":"query","required":false,"example":"2021-01-31T09:00:00Z","schemaId":"schema_115"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","500"],"pointer":"/api/external/v2/audit","href":"audit-log-api/getauditlogs","openApiOperationId":"getAuditLogs","summary":"List Audit Logs (Token-based Pagination)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/celonis-apis/audit-log-api/openapi/openapi-external-v2","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A JSON object representing the paginated results.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SwaggerAuditLogEventTokenBasedPageExternal"}},"schemaId":"components/schemas/SwaggerAuditLogEventTokenBasedPageExternal"},{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request. Please check the response contents for an explanation of the cause."},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.celonis.cloud/help/display/CIBC/Application+Keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.celonis.cloud/help/display/CIBC/Permissions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"code":"403","description":"Forbidden"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An internal error happened. Please forward the associated error ID along with any helpful information to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.celonis.cloud/help/display/CIBC/Support"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"our support"},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1external~1v2~1audit/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SwaggerAuditLogEventTokenBasedPageExternal","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SwaggerAuditLogEventTokenBasedPageExternal"}}},{"code":"204"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit-log-api/getauditlogs"}],"panels":[]}]},"httpPath":"/api/external/v2/audit"}],"content":{"contentType":"group","meta":{"name":"Audit Log API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit Log API","showPageActions":true},{"nodeType":"markdoc","content":"For Querying Audit Logs in a team"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/external/v2/audit","summary":"List Audit Logs (Token-based Pagination)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-log-api/getauditlogs","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AuditLogExternalTransport":{"id":"components/schemas/AuditLogExternalTransport","kind":"json-schema","title":"AuditLogExternalTransport","data":{"type":"object","properties":{"userId":{"type":"string"},"userRole":{"type":"string"},"event":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"message":{},"ipAddress":{"type":"string"},"port":{"type":"string"},"diffPayload":{"$ref":"#/components/schemas/DiffPayloadExternalTransport"}}}},"components/schemas/DiffPayloadExternalTransport":{"id":"components/schemas/DiffPayloadExternalTransport","kind":"json-schema","title":"DiffPayloadExternalTransport","data":{"type":"object","properties":{"oldValue":{"type":"string"},"newValue":{"type":"string"}}}},"components/schemas/SwaggerAuditLogEventTokenBasedPageExternal":{"id":"components/schemas/SwaggerAuditLogEventTokenBasedPageExternal","kind":"json-schema","title":"SwaggerAuditLogEventTokenBasedPageExternal","data":{"type":"object","properties":{"nextPageToken":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogExternalTransport"}}}}},"schema_113":{"kind":"json-schema","data":{"type":"string"},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":200,"maximum":500,"minimum":1},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_115"}},"exampleStore":{},"securitySchemeStore":{"Authorization":{"id":"Authorization","type":"apiKey","description":"Please, prefix the Token with \"AppKey \" or \"Bearer \" (word and space) to indicate the Authorization type","in":"header","paramName":"Authorization"}},"servers":[{"url":"/_mock/celonis-apis/audit-log-api/openapi/openapi-external-v2","isMockServer":true,"description":"Test Server"}]},"options":{"jsonSamplesExpandLevel":"all","schemasExpansionLevel":2,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"PHP"},{"lang":"Python"}]},"feedback":{"type":"comment","settings":{"label":"Share your feedback for this page.","submitText":"Your comment has been sent to our team!"}},"hideSidebar":true,"mockServer":{"url":"/_mock/celonis-apis/audit-log-api/openapi/openapi-external-v2","position":"replace","description":"Test Server","off":false,"strictExamples":false,"errorIfForcedExampleNotFound":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/celonis-apis/audit-log-api/openapi/openapi-external-v2.json?download"},{"url":"/_bundle/celonis-apis/audit-log-api/openapi/openapi-external-v2.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Celonis Audit Log API","description":"This is the documentation for the Celonis Audit Log API that allows querying on audit logs in a Celonis Platform team. This API supports multiple methods of authentication:<br/> <br/> - (preferred method) Via OAuth 2.0 token with scope <tt>audit.log:read</tt>, passed in an HTTP header like this: <tt>Authorization: Bearer TOKEN</tt><br/> - Via Application keys, passed in an HTTP header like this: <tt>Authorization: AppKey APPLICATION_KEY</tt><br/> - Via API keys, passed in an HTTP header like this: <tt>Authorization: Bearer API_KEY</tt><br/><br/>Please see [this help page](https://docs.celonis.com/en/using-oauth-2-0.html) for more information about OAuth 2.0.<br/><br/>**NOTE: ALL AUDIT LOG OPERATIONS ARE SCOPED TO A TEAM.**"}},"baseSlug":"/celonis-apis/audit-log-api/openapi/openapi-external-v2","routesMapping":{}}