SDK
SDK Javascript v6.x
1

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 #

Updates a security role definition.

Note: partial updates are not supported for roles, this API route will replace the entire role content with the provided one.


Copied to clipboard!
updateRole(id, body, [options]);

Property Type Description
id
string
Role identifier
body
object
Role definition content
options
object
Query options

body #

Property Type Description
controllers
object
Role definition

options #

Property Type
(default)
Description
queuable
boolean

(true)
If true, queues the request during downtime, until connected to Kuzzle again
refresh
boolean

(false)
If set to wait_for, Kuzzle will not respond until the updated role is indexed

Resolves #

A Role object representing the updated role.

Usage #

Copied to clipboard!
try {
  const response = await kuzzle.security.updateRole('read-only', {
    controllers: {
      auth: {
        actions: {
          getCurrentUser: true,
          getMyCredentials: true,
          getMyRights: true,
          logout: true
        }
      },
      collection: {
        actions: {
          getMapping: true,
          list: true
        }
      },
      document: {
        actions: {
          count: true,
          get: true,
          mGet: true,
          scroll: true,
          search: true
        }
      },
      index: {
        actions: {
          list: true
        }
      }
    }
  });
  console.log(response);
  /*
  Role {
    _id: 'read-only',
    controllers:
      { auth: { actions: [Object] },
        collection: { actions: [Object] },
        document: { actions: [Object] },
        index: { actions: [Object] }  } }
   */
} catch (e) {
  console.error(e);
}