You're viewing version 3.8 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Role APIs
The role APIs create, retrieve, modify, and delete the roles that define cluster, index, and document permissions.
OpenSearch supports the following role APIs.
| API | Description |
|---|---|
| Create or Update Role API | Creates or replaces the specified role. |
| Patch Roles API | Updates individual attributes of one role, or creates, updates, or deletes multiple roles in a single call. |
| Get Roles API | Retrieves one role or all roles. |
| Delete Role API | Deletes the specified role. |