updateProfileMapping #
Updates the internal profile storage mapping.
updateProfileMapping(mapping, [options]);
Property | Type | Description |
---|---|---|
mapping | object | Profile collection mapping definition |
options | object | Query options |
options #
Property | Type (default) | Description |
---|---|---|
queuable | boolean ( true ) | If true, queues the request during downtime, until connected to Kuzzle again |
Resolves #
An acknowledgment message.
Usage #
try {
const response = await kuzzle.security.updateProfileMapping({
properties: {
description: { type: 'text' }
}
});
console.log(response);
/*
{ acknowledged: true }
*/
} catch (e) {
console.error(e);
}
Edit this page on Github(opens new window)