SDK Java v2.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.

updateRole #

Performs a partial update on an existing role.

updateRole(id, content, [options], [callback]) #

Arguments Type Description
id string Unique role identifier
content JSON Object A plain JSON object representing the role
options string (Optional) Optional arguments
callback function (Optional) Callback handling the response

Options #

Filter Type Description Default
queuable boolean Make this request queuable or not true
refresh string If set to wait_for, Kuzzle will wait for 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 an updated Role object.

Usage #

Copied to clipboard!
JSONObject roleDefinition = new JSONObject()
  .put("controllers", new JSONObject()
    .put("*", new JSONObject()
      .put("actions", new JSONObject()
        .put("*", true)
  .updateRole("Role ID", roleDefinition, new ResponseListener<Role>() {
    public void onSuccess(Role role) {
    public void onError(JSONObject error) {