{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/celonis-apis/permissions-api/overview/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#permissions-api\" aria-label=\"permissions api permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"permissions-api\"></div>Permissions API</h1>\n<p>The Permissions API allows for the querying of Permissions in a Celonis Platform team (not including data level permissions) and then extract this data to provide detailed insights into access management in your team. Once the data is extracted, you can feed the information back into the Celonis Platform to create a data model using your data. This allows you to create your own views in Studio using the data pulled from the API.</p>\n<p>To connect to the APIs and create an extractor, follow <a href=\"/celonis-apis/connecting-to-celonis-platform/\">these procedures</a> which are also the same for Audit logs.</p>\n<h2 style=\"position:relative;\"><a href=\"#use-cases\" aria-label=\"use cases permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"use-cases\"></div>Use Cases</h2>\n<p>The Permissions API can be used to:</p>\n<ul>\n<li>\nConnect external monitoring tools, such as SIEM tools, to capture and monitor platform admin and change events to access management.\n</li>\n<li>\nExport Permission events back into a Celonis Studio view or other tool for analysis or risk assessment needs.\n</li>\n<li>\nExport Permissions configurations back into Celonis Studio to complete a picture of user behaviour along with data from other API’s such as Platform Adoption, Team and Login history.\n</li>\n</ul>\n<h2 style=\"position:relative;\"><a href=\"#authentication\" aria-label=\"authentication permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"authentication\"></div>Authentication</h2>\n<p>This API supports multiple methods of authentication:</p>\n<ul>\n<li>\n(preferred method) Via OAuth 2.0 token with \n<code class=\"language-text\">scope authorization.permissions:read</code>\n, passed in an HTTP header like this: \n<code class=\"language-text\">Authorization: Bearer TOKEN</code>\n.\n</li>\n<li>\nVia Application keys, passed in an HTTP header like this: \n<code class=\"language-text\">Authorization: AppKey APPLICATION_KEY</code>\n.\n</li>\n<li>\nVia API keys, passed in an HTTP header like this: \n<code class=\"language-text\">Authorization: Bearer API_KEY</code>\n.\n</li>\n</ul>\n<p>See <a href=\"https://docs.celonis.com/en/using-oauth-2-0.html\">this help page</a> for more information about OAuth 2.0.</p>","headings":[{"value":"Permissions API","depth":1},{"value":"Use Cases","depth":2},{"value":"Authentication","depth":2}]},"contentItem":{"data":{"lastModified":"2026-01-30T15:59:16.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"4a91b414-c38f-562d-8e48-388b3bb47289__redocly content/celonis-apis/permissions-api/overview/","seo":{"title":"Permissions API","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"celonis-apis/permissions-api/overview.md","pageBaseUrl":"/celonis-apis/permissions-api/overview","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Permissions API","id":"permissions-api"},{"depth":2,"value":"Use Cases","id":"use-cases"},{"depth":2,"value":"Authentication","id":"authentication"}]},"data":{"title":""},"catalogInfo":null,"link":"/celonis-apis/permissions-api/overview/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}