Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions docs/modules/security/pages/client-authorization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,18 @@ can be configured as required.
The following is the list of client permissions that can be configured on the member:
[NOTE]
====
In YAML configuration, permission types use one of two formats:

* **Single object format** (used by `all`, `config`, and `transaction`): These singleton permissions can only have one configuration entry, so they are defined directly as an object without the `-` list indicator.
* **Array format** (used by all other permission types): These permissions support multiple entries with different `name` attributes or configurations, so each entry begins with a `-` to indicate it is a list item.
For example, `all: principal: admin` (single object) versus `map: - name: myMap` (array).

If you see an error like `expected type: JSONArray, found: JSONObject`, check whether you are using the correct format for the permission type.
====

=== All permissions

`<all-permissions>` grants clients access to all data and features.
Expand Down Expand Up @@ -1150,7 +1162,7 @@ XML::
[source,xml]
----
<user-code-namespace-permission principal="principal">
<user-code-namespace-permission principal="principal" name="my_namespace">
<endpoints>
...
</endpoints>
Expand All @@ -1166,11 +1178,12 @@ YAML::
[source,yaml]
----
user-code-namespace:
principal: principal
endpoints:
- ..
actions:
- ..
- name: my_namespace
principal: principal
endpoints:
- ..
actions:
- ..
----
====

Expand Down