Core 2.x

getRole

Gets a security role.


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

Property Type Description
id
string
Role identifier
options
object
Query options

options

Additional query options

Property Type
(default)
Description
queuable
boolean

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

Resolves

The retrieved Role object.

Usage

Copied to clipboard!
try {
  const response = await kuzzle.security.getRole('myRole');
  console.log(response);
  /*
  Role {
    _id: 'myRole',
    controllers:
      { auth:
        { actions: { login: true, getMyRights: true, updateSelf: true } },
        document: { actions: { get: true, search: true } } } }
  */
} catch (e) {
  console.error(e);
}