createProfile

Creates a new profile.


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

Property Type Description
id
string
Profile identifier
profile
object
Profile definition content
options
object
Query options

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 created profile is indexed

Resolves

A Profile object representing the created profile.

Usage

Copied to clipboard!
try {
  const response = await kuzzle.security.createProfile(
    'myProfile',
    {
      policies: [
        {
          roleId: 'default'
        },
        {
          roleId: 'admin',
          restrictedTo: [
            {
              index: 'someIndex',
              collections: [
                'collection1',
                'collection2'
              ]
            }
          ]
        }
      ]
    }
  );
  console.log(response);

  /*
  Profile {
    _id: 'myProfile',
    policies:
      [ { roleId: 'default' },
        { roleId: 'admin', restrictedTo: [Array] } ] }
  */

  console.log('Profile successfully created');
} catch (e) {
  console.error(e);
}