{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Permissions API","description":"API documentation for Celonis APIs.","siteUrl":"https://developer.celonis.com/","keywords":"celonis developer portal, celonis apis, celonis api reference docs","lang":"en-US","llmstxt":{"hide":false,"description":"Celonis API documentation","sections":[{"title":"API Docs","description":"Available Celonis API Docs","includeFiles":["**/*.md"],"excludeFiles":[]},{"title":"API Specs","description":"All Celonis API specifications","includeFiles":["**/openapi.yaml"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"permissions-api","__idx":0},"children":["Permissions API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To connect to the APIs and create an extractor, follow ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/celonis-apis/connecting-to-celonis-platform"},"children":["these procedures"]}," which are also the same for Audit logs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":1},"children":["Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The base URL for the Permissions API is:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["https://",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["your-team"]},".celonis.cloud/api/authorization/external/permissions"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["your-team"]}," with the name of your Celonis instance to access the Permissions API."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"use-cases","__idx":2},"children":["Use Cases"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Permissions API can be used to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Connect external monitoring tools, such as SIEM tools, to capture and monitor platform admin and change events to access management."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Export Permission events back into a Celonis Studio view or other tool for analysis or risk assessment needs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Export 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."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":3},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This API supports multiple methods of authentication:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["(preferred method) Via OAuth 2.0 token with scope ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorization.permissions"]},", passed in an HTTP header like this: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: Bearer TOKEN"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Via Application keys, passed in an HTTP header like this: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: AppKey APPLICATION_KEY"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Via API keys, passed in an HTTP header like this: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: Bearer API_KEY"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.celonis.com/en/using-oauth-2-0.html"},"children":["this help page"]}," for more information about OAuth 2.0."]}]},"headings":[{"value":"Permissions API","id":"permissions-api","depth":1},{"value":"Base URL","id":"base-url","depth":2},{"value":"Use Cases","id":"use-cases","depth":2},{"value":"Authentication","id":"authentication","depth":2}],"frontmatter":{"seo":{"title":"Permissions API"}},"lastModified":"2026-05-13T17:14:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/celonis-apis/permissions-api/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}