Skip to content

Commit

Permalink
Update api.md (#6651)
Browse files Browse the repository at this point in the history
* Update api.md

Add documentation to use APIs that require admin access

Signed-off-by: Morpheus-zzy <[email protected]>

* Update _security/access-control/api.md

Co-authored-by: Stephen Crawford <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _security/access-control/api.md

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Morpheus-zzy <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Stephen Crawford <[email protected]>
  • Loading branch information
3 people authored Mar 12, 2024
1 parent 09f00d3 commit 3416537
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions _security/access-control/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ plugins.security.restapi.roles_enabled: ["<role>", ...]
```
{% include copy.html %}
If you're working with APIs that manage `Distinguished names` or `Certificates` that require super admin access, enable the REST API admin configuration in your `opensearch.yml` file as shown in the following setting example:

```yml
plugins.security.restapi.admin.enabled: true
```
{% include copy.html %}

These roles can now access all APIs. To prevent access to certain APIs:

```yml
Expand Down

0 comments on commit 3416537

Please sign in to comment.