habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/reference-security-put_role.asciidoc Normal file
View File

@ -0,0 +1,72 @@
[[reference-security-put_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.putRole
Create or update roles. The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless.
{ref}/security-api-put-role.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SecurityPutRoleRequest, options?): Promise<SecurityPutRoleResponse>
----
[discrete]
===== `SecurityPutRoleRequest`
[source,ts]
----
interface SecurityPutRoleRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
refresh?: <<shared-type-refresh, Refresh>>
applications?: SecurityApplicationPrivileges[]
cluster?: SecurityClusterPrivilege[]
global?: Record<string, any>
indices?: SecurityIndicesPrivileges[]
remote_indices?: SecurityRemoteIndicesPrivileges[]
metadata?: <<shared-type-metadata, Metadata>>
run_as?: string[]
description?: string
transient_metadata?: Record<string, any>
}
----
[discrete]
===== `SecurityPutRoleResponse`
[source,ts]
----
interface SecurityPutRoleResponse {
role: SecurityCreatedStatus
}
----