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

70
docs/reference-security-put_role_mapping.asciidoc Normal file
View File

@ -0,0 +1,70 @@
[[reference-security-put_role_mapping]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.putRoleMapping
Create or update role mappings. Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. This API does not create roles. Rather, it maps users to existing roles. Roles can be created by using the create or update roles API or roles files.
{ref}/security-api-put-role-mapping.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SecurityPutRoleMappingRequest, options?): Promise<SecurityPutRoleMappingResponse>
----
[discrete]
===== `SecurityPutRoleMappingRequest`
[source,ts]
----
interface SecurityPutRoleMappingRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-name, Name>>
refresh?: <<shared-type-refresh, Refresh>>
enabled?: boolean
metadata?: <<shared-type-metadata, Metadata>>
roles?: string[]
role_templates?: SecurityRoleTemplate[]
rules?: SecurityRoleMappingRule
run_as?: string[]
}
----
[discrete]
===== `SecurityPutRoleMappingResponse`
[source,ts]
----
interface SecurityPutRoleMappingResponse {
created?: boolean
role_mapping: SecurityCreatedStatus
}
----