Delete roles Generally available

View as markdown
DELETE /_security/role/{name}
Api key auth

Delete roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The delete roles API cannot remove roles that are defined in roles files.

Required authorization

  • Cluster privileges: manage_security

Path parameters

  • name string Required

    The name of the role.

Query parameters

  • refresh string

    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 are true, false, or wait_for.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • found boolean Required

      If the role is successfully deleted, found is true. Otherwise, found is false.
DELETE /_security/role/{name} 
DELETE /_security/role/my_admin_role 
resp = client.security.delete_role( name="my_admin_role", )
const response = await client.security.deleteRole({ name: "my_admin_role", });
response = client.security.delete_role( name: "my_admin_role" )
$resp = $client->security()->deleteRole([ "name" => "my_admin_role", ]);
curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_security/role/my_admin_role"
client.security().deleteRole(d -> d .name("my_admin_role") );
Response examples (200)
A successful response from `DELETE /_security/role/my_admin_role`. If the role is successfully deleted, `found` is set to `true`. 
{ "found" : true }