getProfileMapping #

Gets the mapping of the internal security profiles collection.

Copied to clipboard!

getProfileMapping([options]);

Property	Type	Description
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 #

An object representing the internal profiles mapping, using Elasticsearch mapping format.

Usage #

Copied to clipboard!

try {
  const response = await kuzzle.security.getProfileMapping();
  console.log(response);
  /*
  {
    "mapping": {
      "policies": {
        "properties": {
          "roleId": {
            "type": "keyword"
          },
          "restrictedTo": {
            "properties": {
              "collections": {
                "type": "text"
              }
            },
            "index": {
              "type": "text"
            }
          }
        }
      },
    }
  }
    */
} catch (e) {
  console.error(e);
}