maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[DOCS] Completed warning text. (#36672)

Browse source
This commit is contained in:
István Zoltán Szabó 2019-05-22 10:28:24 +02:00 committed by GitHub
parent df6574590d
commit 2a56fb9764
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/api/role-management.asciidoc
View file

@ -2,12 +2,12 @@
[[role-management-api]]
== Kibana Role Management API
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental.]
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."]
The role management API allows people to manage roles that grant <<kibana-privileges>>.
It is *not* supported to do so using the
{ref}/security-api.html#security-role-apis[{es} role management APIs], and doing
so will likely cause {kib}'s authorization to behave unexpectedly.
{ref}/security-api.html#security-role-apis[{es} role management APIs], and doing
so will likely cause {kib}'s authorization to behave unexpectedly.
NOTE: You cannot access these endpoints via the Console in Kibana.

2
docs/api/role-management/delete.asciidoc
View file

@ -1,7 +1,7 @@
[[role-management-api-delete]]
=== Delete role
experimental[This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental.]
experimental["This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental."]
NOTE: You cannot access this endpoint via the Console in Kibana.

6
docs/api/role-management/get.asciidoc
View file

@ -1,7 +1,7 @@
[[role-management-api-get]]
=== Get Role
experimental[This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental.]
experimental["This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental."]
Retrieves all {kib} roles, or a specific role.
@ -26,7 +26,7 @@ GET /api/security/role
===== Response
A successful call returns a response code of `200` and a response body containing a JSON
A successful call returns a response code of `200` and a response body containing a JSON
representation of the roles.
[source,js]
@ -88,7 +88,7 @@ GET /api/security/role/my_kibana_role
===== Response
A successful call returns a response code of `200` and a response body containing a JSON
A successful call returns a response code of `200` and a response body containing a JSON
representation of the role.
[source,js]

10
docs/api/role-management/put.asciidoc
View file

@ -1,7 +1,7 @@
[[role-management-api-put]]
=== Create or Update Role
experimental[This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental.]
experimental["This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental."]
Creates a new {kib} role or updates the attributes of an existing role. {kib} roles are stored in the
{es} native realm.
@ -14,7 +14,7 @@ To use this API, you must have at least the `manage_security` cluster privilege.
==== Request
To create or update a role, issue a PUT request to the
To create or update a role, issue a PUT request to the
`/api/security/role/<rolename>` endpoint.
[source,js]
@ -29,10 +29,10 @@ The following parameters can be specified in the body of a PUT request to add or
`metadata`:: (object) Optional meta-data. Within the `metadata` object, keys
that begin with `_` are reserved for system usage.
`elasticsearch`:: (object) Optional {es} cluster and index privileges, valid keys are
`elasticsearch`:: (object) Optional {es} cluster and index privileges, valid keys are
`cluster`, `indices` and `run_as`. For more information, see {xpack-ref}/defining-roles.html[Defining Roles].
`kibana`:: (object) An object that specifies the <<kibana-privileges>>. Valid keys are `global` and `space`. Privileges defined in the `global` key will apply to all spaces within Kibana, and will take precedent over any privileges defined in the `space` key. For example, specifying `global: ["all"]` will grant full access to all spaces within Kibana, even if the role indicates that a specific space should only have `read` privileges.
`kibana`:: (object) An object that specifies the <<kibana-privileges>>. Valid keys are `global` and `space`. Privileges defined in the `global` key will apply to all spaces within Kibana, and will take precedent over any privileges defined in the `space` key. For example, specifying `global: ["all"]` will grant full access to all spaces within Kibana, even if the role indicates that a specific space should only have `read` privileges.
===== Example
@ -91,7 +91,7 @@ PUT /api/security/role/my_kibana_role
"global": [],
"space": {
"marketing": ["all"],
"engineering": ["read"]
"engineering": ["read"]
}
}
}

2
docs/api/spaces-management.asciidoc
View file

@ -2,7 +2,7 @@
[[spaces-api]]
== Kibana Spaces API
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.]
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
The spaces API allows people to manage their spaces within {kib}.

2
docs/api/spaces-management/delete.asciidoc
View file

@ -1,7 +1,7 @@
[[spaces-api-delete]]
=== Delete space
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.]
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
[WARNING]
==================================================

6
docs/api/spaces-management/get.asciidoc
View file

@ -1,7 +1,7 @@
[[spaces-api-get]]
=== Get Space
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.]
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
Retrieves all {kib} spaces, or a specific space.
@ -22,7 +22,7 @@ GET /api/spaces/space
===== Response
A successful call returns a response code of `200` and a response body containing a JSON
A successful call returns a response code of `200` and a response body containing a JSON
representation of the spaces.
[source,js]
@ -67,7 +67,7 @@ GET /api/spaces/space/marketing
===== Response
A successful call returns a response code of `200` and a response body containing a JSON
A successful call returns a response code of `200` and a response body containing a JSON
representation of the space.
[source,js]

4
docs/api/spaces-management/post.asciidoc
View file

@ -1,7 +1,7 @@
[[spaces-api-post]]
=== Create Space
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.]
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
Creates a new {kib} space. To update an existing space, use the PUT command.
@ -9,7 +9,7 @@ Note: You cannot access this endpoint via the Console in Kibana.
==== Request
To create a space, issue a POST request to the
To create a space, issue a POST request to the
`/api/spaces/space` endpoint.
[source,js]

4
docs/api/spaces-management/put.asciidoc
View file

@ -1,7 +1,7 @@
[[spaces-api-put]]
=== Update Space
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.]
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
Updates an existing {kib} space. To create a new space, use the POST command.
@ -9,7 +9,7 @@ Note: You cannot access this endpoint via the Console in Kibana.
==== Request
To update a space, issue a PUT request to the
To update a space, issue a PUT request to the
`/api/spaces/space/<space_id>` endpoint.
[source,js]