SDK Javascript v5.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

deleteRole #

Delete the provided role.

There is a small delay between the time a role is deleted and it being reflected in the search layer (usually a couple of seconds). That means that a role that was just deleted may still be returned by the searchRoles function at first.

deleteRole(id, [options], [callback]) #

Arguments Type Description
id string Unique role identifier to delete
options JSON Object Optional parameters
callback function (Optional) Callback handling the response

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true
refresh string If set to wait_for, Kuzzle will wait the persistence layer to finish indexing (available with Elasticsearch 5.x and above) undefined

Return Value #

Returns the Security object to allow chaining.

Callback Response #

Returns the id of the rold that has been deleted.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
  .deleteRole('myrole', function(error, result) {
// Using promises (NodeJS)
  .then((result) => {

Callback response

Copied to clipboard!
"deleted role identifier"