Constructors

Instantiates a new Profile object, representing a security profile, which is a set of one or many Role objects.


Profile(Security, id, content, [meta])

Arguments Type Description
Security Security An instantiated Security object
id string Unique profile identifier
content JSON Object Profile content
meta JSON Object Profile metadata

Note: this constructor won't make any call to Kuzzle.


Properties

Property name Type Description get/set
content JSON object Raw profile content get
id string Unique profile identifier get
meta JSON object Profile metadata get

Return Value

Returns to the Profile object.

Usage

Copied to clipboard!
/*
  Constructors are not exposed in the JS/Node SDK.
  Profile objects are returned by Security.profile method:
  */
var profileDefinition = {
  policies: [
    {roleId: 'myrole'},
    {roleId: 'default', restrictedTo: [{index: 'index1'}, {index: 'index2', collections: ['foo', 'bar'] } ] }
  ]
};

var profile = kuzzle.security.profile('myprofile', profileDefinition);