-
Notifications
You must be signed in to change notification settings - Fork 507
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.
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
[DRAFT] Security feature SuperAdmin documentation updates #6927
Changes from all commits
a874534
f7bb2a1
13c7f9d
012d197
2707a74
b77ce42
ab74d5e
2261075
a35762a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -242,3 +242,40 @@ Map the role to your user: | |
1. Choose the **Mapped users** tab and **Manage mapping**. | ||
1. For **Internal users**, add your bulk access user. | ||
1. Choose **Map**. | ||
|
||
## SuperAdmin role | ||
|
||
The `superAdmin` role enables adding, updating, and deleting reserved configurations like roles, roles_mapping, internal_users, action_groups, and tenants. Previously, these configurations were loaded from default YAML files. Now, the `superAdmin` role now has the privilege to add, update, and delete by using API calls. | ||
|
||
### Example API calls: | ||
Following are examples of API calls for `superAdmin` actions: | ||
|
||
Adding a Reserved Configuration: | ||
``` | ||
curl -X PUT https://localhost:9200/_opendistro/_security/api/roles/new_role -k -H 'Content-Type: application/json' -d '{ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. also don't user need to pass Admin certificate for invoking this API, other than invoking locally from the node? Can you verify working of these? |
||
"reserved": true, | ||
"description": "Description of the role", | ||
"cluster_permissions": [], | ||
"index_permissions": [], | ||
"tenant_permissions": [] | ||
}' | ||
``` | ||
{% include copy.html %} | ||
|
||
Updating a Reserved Configuration: | ||
``` | ||
curl -X PUT https://localhost:9200/_opendistro/_security/api/roles/new_role -k -H 'Content-Type: application/json' -d '{ | ||
"reserved": true, | ||
"description": "Updated description", | ||
"cluster_permissions": [], | ||
"index_permissions": [], | ||
"tenant_permissions": [] | ||
}' | ||
``` | ||
{% include copy.html %} | ||
|
||
Deleting a Reserved Configuration: | ||
``` | ||
curl -X DELETE https://localhost:9200/_opendistro/_security/api/roles/new_role -k | ||
``` | ||
{% include copy.html %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we add more examples for roles_mapping, internal_users, action_groups, and tenants as well?