Test run of new docs
This commit is contained in:
68
docs/reference-security-query_role.asciidoc
Normal file
68
docs/reference-security-query_role.asciidoc
Normal file
@ -0,0 +1,68 @@
|
||||
[[reference-security-query_role]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
||||
|| You should update the script that does the generation, which can be found in: ||
|
||||
|| https://github.com/elastic/elastic-client-generator-js ||
|
||||
|| ||
|
||||
|| You can run the script with the following command: ||
|
||||
|| npm run elasticsearch -- --version <version> ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
===========================================================================================================================
|
||||
////////
|
||||
|
||||
[discrete]
|
||||
=== client.security.queryRole
|
||||
|
||||
Find roles with a query. Get roles in a paginated manner. You can optionally filter the results with a query.
|
||||
|
||||
{ref}/security-api-query-role.html[{es} documentation]
|
||||
|
||||
[discrete]
|
||||
==== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(SecurityQueryRoleRequest, options?): Promise<SecurityQueryRoleResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
===== `SecurityQueryRoleRequest`
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
interface SecurityQueryRoleRequest extends <<shared-type-request-base, RequestBase>> {
|
||||
query?: SecurityQueryRoleRoleQueryContainer
|
||||
from?: <<shared-type-integer, integer>>
|
||||
sort?: <<shared-type-sort, Sort>>
|
||||
size?: <<shared-type-integer, integer>>
|
||||
search_after?: <<shared-type-sort-results, SortResults>>
|
||||
}
|
||||
----
|
||||
|
||||
[discrete]
|
||||
===== `SecurityQueryRoleResponse`
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
interface SecurityQueryRoleResponse {
|
||||
total: <<shared-type-integer, integer>>
|
||||
count: <<shared-type-integer, integer>>
|
||||
roles: SecurityQueryRoleQueryRole[]
|
||||
}
|
||||
----
|
||||
|
||||
Reference in New Issue
Block a user