--- type: api title: Bulk create or update roles description: The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/operation/operation-security-bulk-put-role resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/operation/operation-security-bulk-put-role products: - Elasticsearch --- # Bulk create or update roles Availability: 8.15+ ## Paths - `POST` `/_security/role` - [Api key auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#apikeyauth) - [Basic auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#basicauth) - [Bearer auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#bearerauth) ## Description The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files. ## Required authorization * Cluster privileges: `manage_security` ## Query String Parameters - `refresh` (enum Refresh) If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. Values: `true`, `false`, `wait_for` ## Request Body `application/json` - `roles` (map string to RoleDescriptor) — required A dictionary of role name to RoleDescriptor objects to add or update Map values ({} RoleDescriptor) - `cluster` ([] union ClusterPrivilege) — optional A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute. Values: `all`, `cancel_task`, `clone_api_key`, `create_snapshot`, `cross_cluster_replication`, `cross_cluster_search`, `delegate_pki`, `grant_api_key`, `manage`, `manage_api_key`, `manage_autoscaling`, `manage_behavioral_analytics`, `manage_ccr`, `manage_data_frame_transforms`, `manage_data_stream_global_retention`, `manage_enrich`, `manage_esql`, `manage_ilm`, `manage_index_templates`, `manage_inference`, `manage_ingest_pipelines`, `manage_logstash_pipelines`, `manage_ml`, `manage_oidc`, `manage_own_api_key`, `manage_pipeline`, `manage_reindex`, `manage_rollup`, `manage_saml`, `manage_search_application`, `manage_search_query_rules`, `manage_search_synonyms`, `manage_security`, `manage_service_account`, `manage_slm`, `manage_token`, `manage_transform`, `manage_user_profile`, `manage_watcher`, `monitor`, `monitor_data_frame_transforms`, `monitor_data_stream_global_retention`, `monitor_enrich`, `monitor_esql`, `monitor_inference`, `monitor_ml`, `monitor_reindex`, `monitor_rollup`, `monitor_snapshot`, `monitor_stats`, `monitor_text_structure`, `monitor_transform`, `monitor_watcher`, `none`, `post_behavioral_analytics_event`, `read_ccr`, `read_fleet_secrets`, `read_ilm`, `read_pipeline`, `read_security`, `read_slm`, `transport_client`, `write_connector_secrets`, `write_fleet_secrets` - `indices` ([] IndicesPrivileges) — optional A list of indices permissions entries. - `field_security` ({} FieldSecurity) — optional The document fields that the owners of the role have read access to. - `except` (string Fields) — optional - `grant` (string Fields) — optional - `names` (union IndexName | [] IndexName) — required A list of indices (or index name patterns) to which the permissions in this entry apply. - `privileges` ([] union IndexPrivilege) — required The index level privileges that owners of the role have on the specified indices. Values: `all`, `auto_configure`, `create`, `create_doc`, `create_index`, `create_view`, `cross_cluster_replication`, `cross_cluster_replication_internal`, `delete`, `delete_index`, `delete_view`, `index`, `maintenance`, `manage`, `manage_data_stream_lifecycle`, `manage_follow_index`, `manage_ilm`, `manage_leader_index`, `manage_view`, `monitor`, `none`, `read`, `read_cross_cluster`, `read_view_metadata`, `view_index_metadata`, `write` - `query` (IndicesPrivilegesQuery) — optional A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. - `allow_restricted_indices` (boolean · default: false) — optional Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. - `remote_indices` ([] RemoteIndicesPrivileges) — optional A list of indices permissions for remote clusters. - `clusters` (string Names) — required A list of cluster aliases to which the permissions in this entry apply. - `field_security` ({} FieldSecurity) — optional The document fields that the owners of the role have read access to. - `except` (string Fields) — optional - `grant` (string Fields) — optional - `names` (union IndexName | [] IndexName) — required A list of indices (or index name patterns) to which the permissions in this entry apply. - `privileges` ([] union IndexPrivilege) — required The index level privileges that owners of the role have on the specified indices. Values: `all`, `auto_configure`, `create`, `create_doc`, `create_index`, `create_view`, `cross_cluster_replication`, `cross_cluster_replication_internal`, `delete`, `delete_index`, `delete_view`, `index`, `maintenance`, `manage`, `manage_data_stream_lifecycle`, `manage_follow_index`, `manage_ilm`, `manage_leader_index`, `manage_view`, `monitor`, `none`, `read`, `read_cross_cluster`, `read_view_metadata`, `view_index_metadata`, `write` - `query` (IndicesPrivilegesQuery) — optional A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. - `allow_restricted_indices` (boolean · default: false) — optional Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. - `remote_cluster` ([] RemoteClusterPrivileges) — optional A list of cluster permissions for remote clusters. NOTE: This is limited a subset of the cluster permissions. - `clusters` (string Names) — required A list of cluster aliases to which the permissions in this entry apply. - `privileges` ([] enum RemoteClusterPrivilege) — required The cluster level privileges that owners of the role have on the remote cluster. Values: `monitor_enrich`, `monitor_stats` - `global` ({} GlobalPrivilege) — optional An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. - `application` ({} ApplicationGlobalUserPrivileges) — optional - `manage` ({} ManageUserPrivileges) — required - `applications` ([] string) — required - `profile` ({} WriteProfileGlobalUserPrivileges) — optional A privilege that grants the ability to write the `data` and `access` sections of user profiles for the specified applications. - `write` ({} ManageUserPrivileges) — optional The applications for which user profile data can be written. Absent when the `profile` section is present but grants no privileges. - `applications` ([] string) — required - `role` ({} ManageRolesGlobalUserPrivileges) — optional A privilege that grants the ability to manage roles that are scoped to the specified indices. - `manage` ({} ManageRolesPrivileges) — optional The index-scoped role management privileges. Absent when the `role` section is present but grants no privileges. - `indices` ([] ManageRolesIndexPermissions) — required - `names` ([] string) — required A list of indices (or index name patterns) that the owners of the role can manage roles for. - `privileges` ([] string) — required The index privileges that the managed roles are allowed to grant on the specified indices. - `data_source` ([] DataSourcePrivileges) — optional A list of data source privilege entries, used to grant access to ES|QL data sources. - `names` ([] string) — required A list of data source names or wildcard patterns to which the permissions in this entry apply. - `privileges` ([] union DataSourcePrivilege) — required The data source privileges that owners of the role have for the specified data sources. Supported values include: - `create`: Grants privilege to create a data source with a matching name. - `delete`: Grants privilege to delete a data source with a matching name. - `read_metadata`: Grants privilege to read a data source's metadata. - `read`: Grants privilege to attach a dataset to a data source with a matching name. - `manage`: Grants all data source privileges, including `create`, `delete`, `read`, and `read_metadata`. Values: `create`, `delete`, `read_metadata`, `read`, `manage` - `applications` ([] ApplicationPrivileges) — optional A list of application privilege entries - `application` (string) — required The name of the application to which this entry applies. - `privileges` ([] string) — required A list of strings, where each element is the name of an application privilege or action. - `resources` ([] string) — required A list resources to which the privileges are applied. - `metadata` (Metadata) — optional Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage. - `run_as` ([] string) — optional A list of users that the API keys can impersonate. NOTE: In Elastic Cloud Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected. - `description` (string) — optional Optional description of the role descriptor - `restriction` ({} Restriction) — optional Restriction for when the role descriptor is allowed to be effective. - `workflows` ([] union RestrictionWorkflow) — required A list of workflows to which the API key is restricted. NOTE: In order to use a role restriction, an API key must be created with a single role descriptor. Values: `search_application_query` - `transient_metadata` (map string to object) — optional ## Response `application/json` - `created` ([] string) Array of created roles - `updated` ([] string) Array of updated roles - `noop` ([] string) Array of role names without any changes - `errors` ({} BulkError) Present if any updates resulted in errors - `count` (number) The number of errors - `details` (map string to ErrorCause) Details about the errors, keyed by role name Map values ({} ErrorCause) - `type` (string) The type of error - `reason` (union string) — nullable A human-readable explanation of the error, in English. One of: `string` - `stack_trace` (string) The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. - `caused_by` ({} ErrorCause) — recursive - `root_cause` ([] ErrorCause) — recursive - `suppressed` ([] ErrorCause) — recursive ## Code Examples #### Console ```console POST /_security/role { "roles": { "my_admin_role": { "cluster": [ "all" ], "indices": [ { "names": [ "index1", "index2" ], "privileges": [ "all" ], "field_security": { "grant": [ "title", "body" ] }, "query": "{\"match\": {\"title\": \"foo\"}}" } ], "applications": [ { "application": "myapp", "privileges": [ "admin", "read" ], "resources": [ "*" ] } ], "run_as": [ "other_user" ], "metadata": { "version": 1 } }, "my_user_role": { "cluster": [ "all" ], "indices": [ { "names": [ "index1" ], "privileges": [ "read" ], "field_security": { "grant": [ "title", "body" ] }, "query": "{\"match\": {\"title\": \"foo\"}}" } ], "applications": [ { "application": "myapp", "privileges": [ "admin", "read" ], "resources": [ "*" ] } ], "run_as": [ "other_user" ], "metadata": { "version": 1 } } } } ``` #### JavaScript ```javascript const response = await client.security.bulkPutRole({ roles: { my_admin_role: { cluster: ["all"], indices: [ { names: ["index1", "index2"], privileges: ["all"], field_security: { grant: ["title", "body"], }, query: '{"match": {"title": "foo"}}', }, ], applications: [ { application: "myapp", privileges: ["admin", "read"], resources: ["*"], }, ], run_as: ["other_user"], metadata: { version: 1, }, }, my_user_role: { cluster: ["all"], indices: [ { names: ["index1"], privileges: ["read"], field_security: { grant: ["title", "body"], }, query: '{"match": {"title": "foo"}}', }, ], applications: [ { application: "myapp", privileges: ["admin", "read"], resources: ["*"], }, ], run_as: ["other_user"], metadata: { version: 1, }, }, }, }); ``` #### Python ```python resp = client.security.bulk_put_role( roles={ "my_admin_role": { "cluster": [ "all" ], "indices": [ { "names": [ "index1", "index2" ], "privileges": [ "all" ], "field_security": { "grant": [ "title", "body" ] }, "query": "{\"match\": {\"title\": \"foo\"}}" } ], "applications": [ { "application": "myapp", "privileges": [ "admin", "read" ], "resources": [ "*" ] } ], "run_as": [ "other_user" ], "metadata": { "version": 1 } }, "my_user_role": { "cluster": [ "all" ], "indices": [ { "names": [ "index1" ], "privileges": [ "read" ], "field_security": { "grant": [ "title", "body" ] }, "query": "{\"match\": {\"title\": \"foo\"}}" } ], "applications": [ { "application": "myapp", "privileges": [ "admin", "read" ], "resources": [ "*" ] } ], "run_as": [ "other_user" ], "metadata": { "version": 1 } } }, ) ``` #### curl ```curl curl -X POST "$ELASTICSEARCH_URL/_security/role" \ -H "Authorization: ApiKey $ELASTIC_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "roles": { "my_admin_role": { "cluster": [ "all" ], "indices": [ { "names": [ "index1", "index2" ], "privileges": [ "all" ], "field_security": { "grant": [ "title", "body" ] }, "query": "{\u0022match\u0022: {\u0022title\u0022: \u0022foo\u0022}}" } ], "applications": [ { "application": "myapp", "privileges": [ "admin", "read" ], "resources": [ "*" ] } ], "run_as": [ "other_user" ], "metadata": { "version": 1 } }, "my_user_role": { "cluster": [ "all" ], "indices": [ { "names": [ "index1" ], "privileges": [ "read" ], "field_security": { "grant": [ "title", "body" ] }, "query": "{\u0022match\u0022: {\u0022title\u0022: \u0022foo\u0022}}" } ], "applications": [ { "application": "myapp", "privileges": [ "admin", "read" ], "resources": [ "*" ] } ], "run_as": [ "other_user" ], "metadata": { "version": 1 } } } }' ``` #### Java ```java client.security().bulkPutRole(b -> b .roles(Map.of("my_admin_role", RoleDescriptor.roleDescriptorOf(r -> r .cluster("all") .indices(i -> i .fieldSecurity(f -> f .grant(List.of("title","body")) ) .names(List.of("index1","index2")) .privileges("all") .query(q -> q .match(m -> m .field("title") .query(FieldValue.of("foo")) ) ) ) .applications(a -> a .application("myapp") .privileges(List.of("admin","read")) .resources("*") ) .metadata("version", JsonData.fromJson("1")) .runAs("other_user") ),"my_user_role", RoleDescriptor.roleDescriptorOf(ro -> ro .cluster("all") .indices(i -> i .fieldSecurity(f -> f .grant(List.of("title","body")) ) .names("index1") .privileges("read") .query(q -> q .match(m -> m .field("title") .query(FieldValue.of("foo")) ) ) ) .applications(a -> a .application("myapp") .privileges(List.of("admin","read")) .resources("*") ) .metadata("version", JsonData.fromJson("1")) .runAs("other_user") ))) ); ``` #### C# ```c# var response = await client.Security .BulkPutRoleAsync(d1 => d1 .Roles(d2 => d2 .Add("my_admin_role", d3 => d3 .Applications(d4 => d4 .Application("myapp") .Privileges("admin", "read") .Resources("*") ) .Cluster(ClusterPrivilege.All) .Indices(d4 => d4 .FieldSecurity(d5 => d5 .Grant(x => x.Title, x => x.Body) ) .Names(["index1", "index2"]) .Privileges(IndexPrivilege.All) .Query("{\"match\": {\"title\": \"foo\"}}") ) .Metadata(new Dictionary() { { "version", 1 } }) .RunAs("other_user") ) .Add("my_user_role", d3 => d3 .Applications(d4 => d4 .Application("myapp") .Privileges("admin", "read") .Resources("*") ) .Cluster(ClusterPrivilege.All) .Indices(d4 => d4 .FieldSecurity(d5 => d5 .Grant(x => x.Title, x => x.Body) ) .Names(["index1"]) .Privileges(IndexPrivilege.Read) .Query("{\"match\": {\"title\": \"foo\"}}") ) .Metadata(new Dictionary() { { "version", 1 } }) .RunAs("other_user") ) ) ); ``` #### PHP ```php $resp = $client->security()->bulkPutRole([ "body" => [ "roles" => [ "my_admin_role" => [ "cluster" => array( "all", ), "indices" => array( [ "names" => array( "index1", "index2", ), "privileges" => array( "all", ), "field_security" => [ "grant" => array( "title", "body", ), ], "query" => "{\"match\": {\"title\": \"foo\"}}", ], ), "applications" => array( [ "application" => "myapp", "privileges" => array( "admin", "read", ), "resources" => array( "*", ), ], ), "run_as" => array( "other_user", ), "metadata" => [ "version" => 1, ], ], "my_user_role" => [ "cluster" => array( "all", ), "indices" => array( [ "names" => array( "index1", ), "privileges" => array( "read", ), "field_security" => [ "grant" => array( "title", "body", ), ], "query" => "{\"match\": {\"title\": \"foo\"}}", ], ), "applications" => array( [ "application" => "myapp", "privileges" => array( "admin", "read", ), "resources" => array( "*", ), ], ), "run_as" => array( "other_user", ), "metadata" => [ "version" => 1, ], ], ], ], ]); ``` #### Ruby ```ruby response = client.security.bulk_put_role( body: { "roles": { "my_admin_role": { "cluster": [ "all" ], "indices": [ { "names": [ "index1", "index2" ], "privileges": [ "all" ], "field_security": { "grant": [ "title", "body" ] }, "query": "{\"match\": {\"title\": \"foo\"}}" } ], "applications": [ { "application": "myapp", "privileges": [ "admin", "read" ], "resources": [ "*" ] } ], "run_as": [ "other_user" ], "metadata": { "version": 1 } }, "my_user_role": { "cluster": [ "all" ], "indices": [ { "names": [ "index1" ], "privileges": [ "read" ], "field_security": { "grant": [ "title", "body" ] }, "query": "{\"match\": {\"title\": \"foo\"}}" } ], "applications": [ { "application": "myapp", "privileges": [ "admin", "read" ], "resources": [ "*" ] } ], "run_as": [ "other_user" ], "metadata": { "version": 1 } } } } ) ``` ## Response Examples #### A successful response A successful response from `POST /_security/role/my_admin_role` returns a JSON structure that shows whether the role has been created, updated, or had no changes made. ```json { "created": [ "my_admin_role", "my_user_role" ] } ``` #### A partially successful response A partially successful response from `POST /_security/role`. Errors are handled individually for each role create or update, thus the API allows partial success. In this example, the creation of the `my_user_role` role succeeds and the `my_admin_role` role fails. ```json { "created": [ "my_user_role" ], "errors": { "count": 1, "details": { "my_admin_role": { "type": "action_request_validation_exception", "reason": "Validation Failed: 1: unknown cluster privilege [bad_cluster_privilege]. a privilege must be either one of the predefined cluster privilege names [manage_own_api_key,manage_data_stream_global_retention,monitor_data_stream_global_retention,none,cancel_task,cross_cluster_replication,cross_cluster_search,delegate_pki,grant_api_key,manage_autoscaling,manage_index_templates,manage_logstash_pipelines,manage_oidc,manage_saml,manage_search_application,manage_search_query_rules,manage_search_synonyms,manage_service_account,manage_token,manage_user_profile,monitor_connector,monitor_enrich,monitor_inference,monitor_ml,monitor_rollup,monitor_snapshot,monitor_stats,monitor_text_structure,monitor_watcher,post_behavioral_analytics_event,read_ccr,read_connector_secrets,read_fleet_secrets,read_ilm,read_pipeline,read_security,read_slm,transport_client,write_connector_secrets,write_fleet_secrets,create_snapshot,manage_behavioral_analytics,manage_ccr,manage_connector,manage_enrich,manage_ilm,manage_inference,manage_ml,manage_rollup,manage_slm,manage_watcher,monitor_data_frame_transforms,monitor_transform,manage_api_key,manage_ingest_pipelines,manage_pipeline,manage_data_frame_transforms,manage_transform,manage_security,monitor,manage,all] or a pattern over one of the available cluster actions;" } } } } ```