NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› ›

xpack.security.putRole

client.xpack.security.putRole({
  name: string,
  refresh: 'true' | 'false' | 'wait_for',
  body: object
})

`name`	`string` - Role name
`refresh`	`'true' \| 'false' \| 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
`body`	`object` - The role to add