| code | type | title | description |
|---|---|---|---|
true |
page |
createRole |
Security:createRole |
Create a new role in Kuzzle.
:::info There is a small delay between role creation and its availability in our search layer (usually a couple of seconds). That means that a role that was just created may not be returned immediately by the searchRoles function. :::
| Arguments | Type | Description |
|---|---|---|
id |
string | Unique role identifier |
content |
JSON Object | A plain JSON object representing the role |
options |
string | (Optional) Optional arguments |
callback |
function | Callback handling the response |
| Filter | Type | Description | Default |
|---|---|---|---|
replaceIfExist |
boolean | If the same role already exists: throw an error if sets to false. Replace the existing role otherwise | false |
queuable |
boolean | Make this request queuable or not | true |
refresh |
string | If set to wait_for, Kuzzle will wait the persistence layer to finish indexing (available with Elasticsearch 5.x and above) |
undefined |
Returns a Role object.
<<< ./snippets/create-role-1.php