Skip to content

Commit

Permalink
move permission note to warning
Browse files Browse the repository at this point in the history
  • Loading branch information
conceptualshark committed Aug 8, 2024
1 parent 364c059 commit cc9d9b8
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/apis-tools/camunda-api-rest/camunda-api-rest-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,14 @@ See [the interactive Camunda 8 REST API Explorer][camunda-api-explorer] for spec

### Query API

All Query API endpoints contain an `(experimental)` declaration. Those endpoints are not accessible by default in Camunda 8 clusters.
:::warning
Query API endpoints do not currently support [resource authorizations][resource authorizations], and can be used to expand user access to restricted resources. If you use resource permissions, allowing public access to those endpoints is not recommended.
:::

The search endpoints don't yet integrate with [resource authorizations][]. As a result, using search endpoints, users can expand their access to
resources they are not allowed to. Thus, if you use resource permissions, we don't recommend to allow public access to those endpoints.
All Query API endpoints contain an `(experimental)` declaration. Those endpoints are not accessible by default in Camunda 8 clusters.

You can enable the experimental search endpoints by setting the configuration property `camunda.rest.query.enabled` to `true`. Alternatively,
the environment variable `CAMUNDA_REST_QUERY_ENABLED` can be set to `true`.
You can enable the experimental search endpoints by setting either the configuration property `camunda.rest.query.enabled` to `true`,
or the environment variable `CAMUNDA_REST_QUERY_ENABLED` to `true`.

[camunda-api-explorer]: ./specifications/camunda-8-rest-api.info.mdx
[resource authorizations]: /self-managed/concepts/access-control/resource-authorizations.md

0 comments on commit cc9d9b8

Please sign in to comment.