Skip to content

Update Resource Sharing docs with config file rename #6034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cwperks merged 1 commit into from
Mar 25, 2026
+5 −5
Merged

Update Resource Sharing docs with config file rename #6034

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions RESOURCE_SHARING_AND_ACCESS_CONTROL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ opensearchplugin {
```
org.opensearch.sample.SampleResourceSharingExtension
```
- **Declare** action-groups **per resource** in `resource-action-groups.yml` file:
- **Declare** action-groups **per resource** in `resource-access-levels.yml` file:
```
src/main/resources/resource-action-groups.yml
src/main/resources/resource-access-levels.yml
```
- This file must be structured in a following way:
```yml
Expand Down Expand Up @@ -116,7 +116,7 @@ opensearchplugin {
```
**NOTE**: The resource-type supplied here must match the ones supplied in each of the resource-providers declared in the ResourceSharingExtension implementation.

#### **Example resource-action-groups yml**
#### **Example resource-access-levels yml**
```yml
resource_types:
sample-resource:
Expand Down Expand Up @@ -611,7 +611,7 @@ Read documents from a plugin’s index and migrate ownership and backend role-ba
| `username_path` | string | yes | JSON Pointer to the username field inside each document |
| `backend_roles_path` | string | yes | JSON Pointer to the backend_roles field (must point to a JSON array) |
| `default_owner` | string | yes | Name of the user to be used as owner for resource without owner information |
| `default_access_level` | object | yes | Default access level to assign migrated backend_roles. Must be one from the available action-groups for this type. See `resource-action-groups.yml`. |
| `default_access_level` | object | yes | Default access level to assign migrated backend_roles. Must be one from the available action-groups for this type. See `resource-access-levels.yml`. |

**Example Request**
`POST /_plugins/_security/api/resources/migrate`
Expand Down Expand Up @@ -811,7 +811,7 @@ GET /_plugins/_security/api/resource/types
]
}
```
NOTE: `action_groups` are fetched from `resource-action-groups.yml` supplied by resource plugin.
NOTE: `action_groups` are fetched from `resource-access-levels.yml` supplied by resource plugin.

### 5. `GET /_plugins/_security/api/resource/list?resource_type=<type>`

Expand Down
Loading